Download OpenAPI specification:Download
The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas. To learn more, review the Administration API overview. This OpenAPI specification covers all of the collections with the exception of Alerts, Alert Configurations, and Events. Refer to the legacy documentation for the specifications of these resources.
Returns access logs for authentication attempts made to MongoDB Cloud database deployments.
Returns the access logs of one cluster identified by the cluster's name. Access logs contain a list of authentication requests made against your cluster. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| authResult |
boolean
Flag that indicates whether the response returns the successful authentication attempts only. |
| end |
string
Date and time when to stop retrieving database history. If you specify end, you must also specify start. This parameter uses the ISO 8601 timestamp format in UTC. |
| ipAddress |
string^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...
One Internet Protocol address that attempted to authenticate with the database. |
| nLogs |
integer
<int64>
[ 0 .. 20000 ]
Default:
20000
Maximum number of lines from the log to return. |
| start |
string
<date-time>
Date and time when MongoDB Cloud begins retrieving database history. If you specify start, you must also specify end. This parameter uses the ISO 8601 timestamp format in UTC. |
{
-
"accessLogs":
[
-
{
-
"authResult": true,
-
"authSource":
"string",
-
"failureReason":
"string",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"hostname":
"string",
-
"ipAddress":
"string",
-
"logLine":
"string",
-
"timestamp":
"string",
-
"username":
"string"
}
]
}
Returns the access logs of one cluster identified by the cluster's hostname. Access logs contain a list of authentication requests made against your clusters. You can't use this feature on tenant-tier clusters (M0, M2, M5). To use this resource, the requesting API Key must have the Project Monitoring Admin role.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
hostname
required
|
string
Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| authResult |
boolean
Flag that indicates whether the response returns the successful authentication attempts only. |
| end |
string
<date-time>
Date and time when to stop retrieving database history. If you specify end, you must also specify start. This parameter uses the ISO 8601 timestamp format in UTC. |
| ipAddress |
string^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...
One Internet Protocol address that attempted to authenticate with the database. |
| nLogs |
integer
<int32>
[ 0 .. 20000 ]
Default:
20000
Maximum number of lines from the log to return. |
| start |
string
<date-time>
Date and time when MongoDB Cloud begins retrieving database history. If you specify start, you must also specify end. This parameter uses the ISO 8601 timestamp format in UTC. |
{
-
"accessLogs":
[
-
{
-
"authResult": true,
-
"authSource":
"string",
-
"failureReason":
"string",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"hostname":
"string",
-
"ipAddress":
"string",
-
"logLine":
"string",
-
"timestamp":
"string",
-
"username":
"string"
}
]
}
Returns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change. Refer to the legacy documentation for this collection in the following link.
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
[
-
"TYPE_NAME"
]
Returns all alert configurations for one project. These alert configurations apply to any component in the project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
This resource remains under revision and may change. Refer to the legacy documentation for this resource.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"created":
"2019-08-24T14:15:22Z",
-
"enabled": false,
-
"eventTypeName":
"HOST_DOWN",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"adddde5af4ee4bd0b519375f",
-
"links":
[
-
],
-
"matchers":
[
-
{
-
"fieldName":
"TYPE_NAME",
-
"operator":
"EQUALS",
-
"value":
"PRIMARY"
}
],
-
"metricThreshold":
{
-
"metricName":
"ASSERT_MSG",
-
"mode":
"TOTAL",
-
"operator":
"LESS_THAN",
-
"threshold": 0,
-
"units":
"BITS"
},
-
"notifications":
[
-
{
-
"apiToken":
"**********************************************************************abcd",
-
"channelName":
"alerts",
-
"datadogApiKey":
"****************************a23c",
-
"datadogRegion":
"US",
-
"delayMin":
0,
-
"emailAddress":
"user@example.com",
-
"emailEnabled":
true,
-
"intervalMin":
5,
-
-
"mobileNumber":
"1233337892",
-
"notificationToken":
"************************************1234",
-
"opsGenieApiKey":
"********************************a111",
-
"opsGenieRegion":
"US",
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"roomName":
"test room",
-
"serviceKey":
"****************************7890",
-
"severity":
"CRITICAL",
-
"smsEnabled":
true,
-
"teamId":
"e254e4ade2206f4520d4107d",
-
"teamName":
"Atlas",
-
"typeName":
"DATADOG",
-
"username":
"user@example.com",
-
"victorOpsApiKey":
"********************************9abc",
-
"victorOpsRoutingKey":
"test routing",
-
"webhookSecret":
"******",
-
}
],
-
"threshold":
{
-
"operator":
"LESS_THAN",
-
"threshold": 0,
-
"units":
"BITS"
},
-
"typeName":
"HOST",
-
"updated":
"2019-08-24T14:15:22Z"
}
],
-
"totalCount":
0
}
Creates one alert configuration for the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.
This resource remains under revision and may change. Refer to the legacy documentation for this resource.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Creates one alert configuration for the specified project.
| enabled |
boolean
Default:
false
Flag that indicates whether someone enabled this alert configuration for the specified project. |
|
eventTypeName
required
|
string
Enum:
"AWS_ENCRYPTION_KEY_NEEDS_ROTATION"
"AZURE_ENCRYPTION_KEY_NEEDS_ROTATION"
"CLUSTER_MONGOS_IS_MISSING"
"CPS_RESTORE_FAILED"
"CPS_RESTORE_SUCCESSFUL"
"CPS_SNAPSHOT_BEHIND"
"CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED"
"CPS_SNAPSHOT_FALLBACK_FAILED"
"CPS_SNAPSHOT_FALLBACK_SUCCESSFUL"
"CPS_SNAPSHOT_SUCCESSFUL"
"CREDIT_CARD_ABOUT_TO_EXPIRE"
"DAILY_BILL_OVER_THRESHOLD"
"GCP_ENCRYPTION_KEY_NEEDS_ROTATION"
"HOST_DOWN"
"JOINED_GROUP"
"NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK"
"NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK"
"NO_PRIMARY"
"OUTSIDE_METRIC_THRESHOLD"
"OUTSIDE_SERVERLESS_METRIC_THRESHOLD"
"OUTSIDE_REALM_METRIC_THRESHOLD"
"PENDING_INVOICE_OVER_THRESHOLD"
"PRIMARY_ELECTED"
"REMOVED_FROM_GROUP"
"REPLICATION_OPLOG_WINDOW_RUNNING_OUT"
"TOO_MANY_ELECTIONS"
"USER_ROLES_CHANGED_AUDIT"
"USERS_WITHOUT_MULTIFACTOR_AUTH"
Event type that triggers an alert. IMPORTANT: The complete list of event type values changes frequently. |
|
Array of objects
(Matchers)
List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the eventTypeName specifies an event for a host, replica set, or sharded cluster. |
|
|
object
(Metric Threshold)
Threshold for the metric that, when exceeded, triggers an alert. The
resource returns this parameter when
|
|
|
Array of objects
(Notifications)
List that contains the targets that MongoDB Cloud sends notifications. NOTE: Notifications vary. A notification may only include a subset of these elements. |
|
|
object
(Threshold)
Limit that triggers an alert when exceeded. The resource returns
this parameter when eventTypeName has not been set
to |
{
-
"enabled":
false,
-
"eventTypeName":
"HOST_DOWN",
-
"matchers":
[
-
{
-
"fieldName":
"TYPE_NAME",
-
"operator":
"EQUALS",
-
"value":
"PRIMARY"
}
],
-
"metricThreshold": {
-
"metricName":
"ASSERT_MSG",
-
"mode":
"TOTAL",
-
"operator":
"LESS_THAN",
-
"threshold": 0,
-
"units":
"BITS"
},
-
"notifications":
[
-
{
-
"apiToken":
"**********************************************************************abcd",
-
"channelName":
"alerts",
-
"datadogApiKey":
"****************************a23c",
-
"datadogRegion":
"US",
-
"delayMin": 0,
-
"emailAddress":
"user@example.com",
-
"emailEnabled": true,
-
"intervalMin": 5,
-
-
"mobileNumber":
"1233337892",
-
"notificationToken":
"************************************1234",
-
"opsGenieApiKey":
"********************************a111",
-
"opsGenieRegion":
"US",
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"roomName":
"test room",
-
"serviceKey":
"****************************7890",
-
"severity":
"CRITICAL",
-
"smsEnabled": true,
-
"teamId":
"e254e4ade2206f4520d4107d",
-
"teamName":
"Atlas",
-
"typeName":
"DATADOG",
-
"username":
"user@example.com",
-
"victorOpsApiKey":
"********************************9abc",
-
"victorOpsRoutingKey":
"test routing",
-
"webhookSecret":
"******",
-
}
],
-
"threshold":
{
-
"operator":
"LESS_THAN",
-
"threshold": 0,
-
"units":
"BITS"
}
}
{
-
"created":
"2019-08-24T14:15:22Z",
-
"enabled":
false,
-
"eventTypeName":
"HOST_DOWN",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"adddde5af4ee4bd0b519375f",
-
"links":
[
-
],
-
"matchers":
[
-
{
-
"fieldName":
"TYPE_NAME",
-
"operator":
"EQUALS",
-
"value":
"PRIMARY"
}
],
-
"metricThreshold": {
-
"metricName":
"ASSERT_MSG",
-
"mode":
"TOTAL",
-
"operator":
"LESS_THAN",
-
"threshold": 0,
-
"units":
"BITS"
},
-
"notifications":
[
-
{
-
"apiToken":
"**********************************************************************abcd",
-
"channelName":
"alerts",
-
"datadogApiKey":
"****************************a23c",
-
"datadogRegion":
"US",
-
"delayMin": 0,
-
"emailAddress":
"user@example.com",
-
"emailEnabled": true,
-
"intervalMin": 5,
-
-
"mobileNumber":
"1233337892",
-
"notificationToken":
"************************************1234",
-
"opsGenieApiKey":
"********************************a111",
-
"opsGenieRegion":
"US",
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"roomName":
"test room",
-
"serviceKey":
"****************************7890",
-
"severity":
"CRITICAL",
-
"smsEnabled": true,
-
"teamId":
"e254e4ade2206f4520d4107d",
-
"teamName":
"Atlas",
-
"typeName":
"DATADOG",
-
"username":
"user@example.com",
-
"victorOpsApiKey":
"********************************9abc",
-
"victorOpsRoutingKey":
"test routing",
-
"webhookSecret":
"******",
-
}
],
-
"threshold":
{
-
"operator":
"LESS_THAN",
-
"threshold": 0,
-
"units":
"BITS"
},
-
"typeName":
"HOST",
-
"updated":
"2019-08-24T14:15:22Z"
}
Removes one alert configuration from the specified project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.
This resource remains under revision and may change. Refer to the legacy documentation for this resource.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
alertConfigId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
adddde5af4ee4bd0b519375f
Unique 24-hexadecimal digit string that identifies the alert configuration. Use the /alertConfigs endpoint to retrieve all alert configurations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint)",
-
"error":
401,
-
"errorCode":
"NOT_ORG_GROUP_CREATOR",
-
"parameters":
[
-
"EXAMPLE"
],
-
"reason":
"Unauthorized"
}
Returns the specified alert configuration from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
This resource remains under revision and may change. Refer to the legacy documentation for this resource.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
alertConfigId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
adddde5af4ee4bd0b519375f
Unique 24-hexadecimal digit string that identifies the alert configuration. Use the /alertConfigs endpoint to retrieve all alert configurations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"created":
"2019-08-24T14:15:22Z",
-
"enabled":
false,
-
"eventTypeName":
"HOST_DOWN",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"adddde5af4ee4bd0b519375f",
-
"links":
[
-
],
-
"matchers":
[
-
{
-
"fieldName":
"TYPE_NAME",
-
"operator":
"EQUALS",
-
"value":
"PRIMARY"
}
],
-
"metricThreshold": {
-
"metricName":
"ASSERT_MSG",
-
"mode":
"TOTAL",
-
"operator":
"LESS_THAN",
-
"threshold": 0,
-
"units":
"BITS"
},
-
"notifications":
[
-
{
-
"apiToken":
"**********************************************************************abcd",
-
"channelName":
"alerts",
-
"datadogApiKey":
"****************************a23c",
-
"datadogRegion":
"US",
-
"delayMin": 0,
-
"emailAddress":
"user@example.com",
-
"emailEnabled": true,
-
"intervalMin": 5,
-
-
"mobileNumber":
"1233337892",
-
"notificationToken":
"************************************1234",
-
"opsGenieApiKey":
"********************************a111",
-
"opsGenieRegion":
"US",
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"roomName":
"test room",
-
"serviceKey":
"****************************7890",
-
"severity":
"CRITICAL",
-
"smsEnabled": true,
-
"teamId":
"e254e4ade2206f4520d4107d",
-
"teamName":
"Atlas",
-
"typeName":
"DATADOG",
-
"username":
"user@example.com",
-
"victorOpsApiKey":
"********************************9abc",
-
"victorOpsRoutingKey":
"test routing",
-
"webhookSecret":
"******",
-
}
],
-
"threshold":
{
-
"operator":
"LESS_THAN",
-
"threshold": 0,
-
"units":
"BITS"
},
-
"typeName":
"HOST",
-
"updated":
"2019-08-24T14:15:22Z"
}
Enables or disables the specified alert configuration in the specified project. The resource enables the specified alert configuration if currently enabled. The resource disables the specified alert configuration if currently disabled. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.
NOTE: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see Update One Alert Configuration.
This resource remains under revision and may change. Refer to the legacy documentation for this resource.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
alertConfigId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
adddde5af4ee4bd0b519375f
Unique 24-hexadecimal digit string that identifies the alert configuration that triggered this alert. Use the /alertConfigs endpoint to retrieve all alert configurations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Enables or disables the specified alert configuration in the specified project.
Flag that indicates whether to enable or disable the specified alert configuration in the specified project.
true
{
-
"created":
"2019-08-24T14:15:22Z",
-
"enabled":
false,
-
"eventTypeName":
"HOST_DOWN",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"adddde5af4ee4bd0b519375f",
-
"links":
[
-
],
-
"matchers":
[
-
{
-
"fieldName":
"TYPE_NAME",
-
"operator":
"EQUALS",
-
"value":
"PRIMARY"
}
],
-
"metricThreshold": {
-
"metricName":
"ASSERT_MSG",
-
"mode":
"TOTAL",
-
"operator":
"LESS_THAN",
-
"threshold": 0,
-
"units":
"BITS"
},
-
"notifications":
[
-
{
-
"apiToken":
"**********************************************************************abcd",
-
"channelName":
"alerts",
-
"datadogApiKey":
"****************************a23c",
-
"datadogRegion":
"US",
-
"delayMin": 0,
-
"emailAddress":
"user@example.com",
-
"emailEnabled": true,
-
"intervalMin": 5,
-
-
"mobileNumber":
"1233337892",
-
"notificationToken":
"************************************1234",
-
"opsGenieApiKey":
"********************************a111",
-
"opsGenieRegion":
"US",
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"roomName":
"test room",
-
"serviceKey":
"****************************7890",
-
"severity":
"CRITICAL",
-
"smsEnabled": true,
-
"teamId":
"e254e4ade2206f4520d4107d",
-
"teamName":
"Atlas",
-
"typeName":
"DATADOG",
-
"username":
"user@example.com",
-
"victorOpsApiKey":
"********************************9abc",
-
"victorOpsRoutingKey":
"test routing",
-
"webhookSecret":
"******",
-
}
],
-
"threshold":
{
-
"operator":
"LESS_THAN",
-
"threshold": 0,
-
"units":
"BITS"
},
-
"typeName":
"HOST",
-
"updated":
"2019-08-24T14:15:22Z"
}
Updates one alert configuration in the specified project. Alert configurations define the triggers and notification methods for alerts. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role.
NOTE: To enable or disable the alert configuration, see Toggle One State of One Alert Configuration in One Project.
This resource remains under revision and may change. Refer to the legacy documentation for this resource.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
alertConfigId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
adddde5af4ee4bd0b519375f
Unique 24-hexadecimal digit string that identifies the alert configuration. Use the /alertConfigs endpoint to retrieve all alert configurations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Updates one alert configuration in the specified project.
| enabled |
boolean
Default:
false
Flag that indicates whether someone enabled this alert configuration for the specified project. |
|
eventTypeName
required
|
string
Enum:
"AWS_ENCRYPTION_KEY_NEEDS_ROTATION"
"AZURE_ENCRYPTION_KEY_NEEDS_ROTATION"
"CLUSTER_MONGOS_IS_MISSING"
"CPS_RESTORE_FAILED"
"CPS_RESTORE_SUCCESSFUL"
"CPS_SNAPSHOT_BEHIND"
"CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED"
"CPS_SNAPSHOT_FALLBACK_FAILED"
"CPS_SNAPSHOT_FALLBACK_SUCCESSFUL"
"CPS_SNAPSHOT_SUCCESSFUL"
"CREDIT_CARD_ABOUT_TO_EXPIRE"
"DAILY_BILL_OVER_THRESHOLD"
"GCP_ENCRYPTION_KEY_NEEDS_ROTATION"
"HOST_DOWN"
"JOINED_GROUP"
"NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK"
"NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK"
"NO_PRIMARY"
"OUTSIDE_METRIC_THRESHOLD"
"OUTSIDE_SERVERLESS_METRIC_THRESHOLD"
"OUTSIDE_REALM_METRIC_THRESHOLD"
"PENDING_INVOICE_OVER_THRESHOLD"
"PRIMARY_ELECTED"
"REMOVED_FROM_GROUP"
"REPLICATION_OPLOG_WINDOW_RUNNING_OUT"
"TOO_MANY_ELECTIONS"
"USER_ROLES_CHANGED_AUDIT"
"USERS_WITHOUT_MULTIFACTOR_AUTH"
Event type that triggers an alert. IMPORTANT: The complete list of event type values changes frequently. |
|
Array of objects
(Matchers)
List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the eventTypeName specifies an event for a host, replica set, or sharded cluster. |
|
|
object
(Metric Threshold)
Threshold for the metric that, when exceeded, triggers an alert. The
resource returns this parameter when
|
|
|
Array of objects
(Notifications)
List that contains the targets that MongoDB Cloud sends notifications. NOTE: Notifications vary. A notification may only include a subset of these elements. |
|
|
object
(Threshold)
Limit that triggers an alert when exceeded. The resource returns
this parameter when eventTypeName has not been set
to |
{
-
"enabled":
false,
-
"eventTypeName":
"HOST_DOWN",
-
"matchers":
[
-
{
-
"fieldName":
"TYPE_NAME",
-
"operator":
"EQUALS",
-
"value":
"PRIMARY"
}
],
-
"metricThreshold": {
-
"metricName":
"ASSERT_MSG",
-
"mode":
"TOTAL",
-
"operator":
"LESS_THAN",
-
"threshold": 0,
-
"units":
"BITS"
},
-
"notifications":
[
-
{
-
"apiToken":
"**********************************************************************abcd",
-
"channelName":
"alerts",
-
"datadogApiKey":
"****************************a23c",
-
"datadogRegion":
"US",
-
"delayMin": 0,
-
"emailAddress":
"user@example.com",
-
"emailEnabled": true,
-
"intervalMin": 5,
-
-
"mobileNumber":
"1233337892",
-
"notificationToken":
"************************************1234",
-
"opsGenieApiKey":
"********************************a111",
-
"opsGenieRegion":
"US",
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"roomName":
"test room",
-
"serviceKey":
"****************************7890",
-
"severity":
"CRITICAL",
-
"smsEnabled": true,
-
"teamId":
"e254e4ade2206f4520d4107d",
-
"teamName":
"Atlas",
-
"typeName":
"DATADOG",
-
"username":
"user@example.com",
-
"victorOpsApiKey":
"********************************9abc",
-
"victorOpsRoutingKey":
"test routing",
-
"webhookSecret":
"******",
-
}
],
-
"threshold":
{
-
"operator":
"LESS_THAN",
-
"threshold": 0,
-
"units":
"BITS"
}
}
{
-
"created":
"2019-08-24T14:15:22Z",
-
"enabled":
false,
-
"eventTypeName":
"HOST_DOWN",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"adddde5af4ee4bd0b519375f",
-
"links":
[
-
],
-
"matchers":
[
-
{
-
"fieldName":
"TYPE_NAME",
-
"operator":
"EQUALS",
-
"value":
"PRIMARY"
}
],
-
"metricThreshold": {
-
"metricName":
"ASSERT_MSG",
-
"mode":
"TOTAL",
-
"operator":
"LESS_THAN",
-
"threshold": 0,
-
"units":
"BITS"
},
-
"notifications":
[
-
{
-
"apiToken":
"**********************************************************************abcd",
-
"channelName":
"alerts",
-
"datadogApiKey":
"****************************a23c",
-
"datadogRegion":
"US",
-
"delayMin": 0,
-
"emailAddress":
"user@example.com",
-
"emailEnabled": true,
-
"intervalMin": 5,
-
-
"mobileNumber":
"1233337892",
-
"notificationToken":
"************************************1234",
-
"opsGenieApiKey":
"********************************a111",
-
"opsGenieRegion":
"US",
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"roomName":
"test room",
-
"serviceKey":
"****************************7890",
-
"severity":
"CRITICAL",
-
"smsEnabled": true,
-
"teamId":
"e254e4ade2206f4520d4107d",
-
"teamName":
"Atlas",
-
"typeName":
"DATADOG",
-
"username":
"user@example.com",
-
"victorOpsApiKey":
"********************************9abc",
-
"victorOpsRoutingKey":
"test routing",
-
"webhookSecret":
"******",
-
}
],
-
"threshold":
{
-
"operator":
"LESS_THAN",
-
"threshold": 0,
-
"units":
"BITS"
},
-
"typeName":
"HOST",
-
"updated":
"2019-08-24T14:15:22Z"
}
Returns all alert configurations set for the specified alert. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
This resource remains under revision and may change.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
alertId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the alert. Use the /alerts endpoint to retrieve all alerts to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"created":
"2019-08-24T14:15:22Z",
-
"enabled": false,
-
"eventTypeName":
"HOST_DOWN",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"adddde5af4ee4bd0b519375f",
-
"links":
[
-
],
-
"matchers":
[
-
{
-
"fieldName":
"TYPE_NAME",
-
"operator":
"EQUALS",
-
"value":
"PRIMARY"
}
],
-
"metricThreshold":
{
-
"metricName":
"ASSERT_MSG",
-
"mode":
"TOTAL",
-
"operator":
"LESS_THAN",
-
"threshold": 0,
-
"units":
"BITS"
},
-
"notifications":
[
-
{
-
"apiToken":
"**********************************************************************abcd",
-
"channelName":
"alerts",
-
"datadogApiKey":
"****************************a23c",
-
"datadogRegion":
"US",
-
"delayMin":
0,
-
"emailAddress":
"user@example.com",
-
"emailEnabled":
true,
-
"intervalMin":
5,
-
-
"mobileNumber":
"1233337892",
-
"notificationToken":
"************************************1234",
-
"opsGenieApiKey":
"********************************a111",
-
"opsGenieRegion":
"US",
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"roomName":
"test room",
-
"serviceKey":
"****************************7890",
-
"severity":
"CRITICAL",
-
"smsEnabled":
true,
-
"teamId":
"e254e4ade2206f4520d4107d",
-
"teamName":
"Atlas",
-
"typeName":
"DATADOG",
-
"username":
"user@example.com",
-
"victorOpsApiKey":
"********************************9abc",
-
"victorOpsRoutingKey":
"test routing",
-
"webhookSecret":
"******",
-
}
],
-
"threshold":
{
-
"operator":
"LESS_THAN",
-
"threshold": 0,
-
"units":
"BITS"
},
-
"typeName":
"HOST",
-
"updated":
"2019-08-24T14:15:22Z"
}
],
-
"totalCount":
0
}
Returns and acknowledges alerts that MongoDB Cloud triggers based on the alert conditions that you define. This collection remains under revision and may change. Refer to the legacy documentation for this collection in the following link.
Returns all open alerts that the specified alert configuration triggers. These alert configurations apply to the specified project only. Alert configurations define the triggers and notification methods for alerts. Open alerts have been triggered but remain unacknowledged. To use this resource, the requesting API Key must have the Project Read Only role.
This resource remains under revision and may change. Refer to the legacy documentation for this resource.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
alertConfigId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
adddde5af4ee4bd0b519375f
Unique 24-hexadecimal digit string that identifies the alert configuration. Use the /alertConfigs endpoint to retrieve all alert configurations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"acknowledgedUntil":
"2019-08-24T14:15:22Z",
-
"acknowledgementComment":
"Expiration on 3/19. Silencing for
7days.",
-
"acknowledgingUsername":
"user@example.com",
-
"alertConfigId":
"adddde5af4ee4bd0b519375f",
-
"created":
"2019-08-24T14:15:22Z",
-
"eventTypeName":
"NEW_AGENT",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"d268e3a6e1718c6c36376f73",
-
"lastNotified":
"2019-08-24T14:15:22Z",
-
"links":
[
-
],
-
"orgId":
"4888442a3354817a7320eb61",
-
"resolved":
"2019-08-24T14:15:22Z",
-
"status":
"OPEN",
-
"updated":
"2019-08-24T14:15:22Z"
}
],
-
"totalCount":
0
}
Returns all alerts. These alerts apply to all components in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
This resource remains under revision and may change. Refer to the legacy documentation for this resource.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"acknowledgedUntil":
"2019-08-24T14:15:22Z",
-
"acknowledgementComment":
"Expiration on 3/19. Silencing for
7days.",
-
"acknowledgingUsername":
"user@example.com",
-
"alertConfigId":
"adddde5af4ee4bd0b519375f",
-
"created":
"2019-08-24T14:15:22Z",
-
"eventTypeName":
"NEW_AGENT",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"d268e3a6e1718c6c36376f73",
-
"lastNotified":
"2019-08-24T14:15:22Z",
-
"links":
[
-
],
-
"orgId":
"4888442a3354817a7320eb61",
-
"resolved":
"2019-08-24T14:15:22Z",
-
"status":
"OPEN",
-
"updated":
"2019-08-24T14:15:22Z"
}
],
-
"totalCount":
0
}
Returns one alert. This alert applies to any component in one project. You receive an alert when a monitored component meets or exceeds a value you set. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
This resource remains under revision and may change. Refer to the legacy documentation for this resource.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
alertId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the alert. Use the /alerts endpoint to retrieve all alerts to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"acknowledgedUntil":
"2019-08-24T14:15:22Z",
-
"acknowledgementComment":
"Expiration on 3/19. Silencing for
7days.",
-
"acknowledgingUsername":
"user@example.com",
-
"alertConfigId":
"adddde5af4ee4bd0b519375f",
-
"created":
"2019-08-24T14:15:22Z",
-
"eventTypeName": "NEW_AGENT",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"d268e3a6e1718c6c36376f73",
-
"lastNotified":
"2019-08-24T14:15:22Z",
-
"links":
[
-
],
-
"orgId":
"4888442a3354817a7320eb61",
-
"resolved":
"2019-08-24T14:15:22Z",
-
"status":
"OPEN",
-
"updated":
"2019-08-24T14:15:22Z"
}
Confirms receipt of one existing alert. This alert applies to any component in one project. Acknowledging an alert prevents successive notifications. You receive an alert when a monitored component meets or exceeds a value you set until you acknowledge the alert. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This resource doesn't require the API Key to have an Access List.
This resource remains under revision and may change. Refer to the legacy documentation for this resource.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
alertId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the alert. Use the /alerts endpoint to retrieve all alerts to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Confirm one alert.
|
acknowledgedUntil
required
|
string
<date-time>
Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
|
| acknowledgementComment |
string
<= 200 characters
Comment that a MongoDB Cloud user submitted when acknowledging the alert. |
{
-
"acknowledgedUntil":
"2019-08-24T14:15:22Z",
-
"acknowledgementComment":
"Expiration on 3/19. Silencing for
7days."
}
{
-
"acknowledgedUntil":
"2019-08-24T14:15:22Z",
-
"acknowledgementComment":
"Expiration on 3/19. Silencing for
7days.",
-
"acknowledgingUsername":
"user@example.com",
-
"alertConfigId":
"adddde5af4ee4bd0b519375f",
-
"created":
"2019-08-24T14:15:22Z",
-
"eventTypeName": "NEW_AGENT",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"d268e3a6e1718c6c36376f73",
-
"lastNotified":
"2019-08-24T14:15:22Z",
-
"links":
[
-
],
-
"orgId":
"4888442a3354817a7320eb61",
-
"resolved":
"2019-08-24T14:15:22Z",
-
"status":
"OPEN",
-
"updated":
"2019-08-24T14:15:22Z"
}
Returns, adds, edits, and removes Atlas Search indexes. Also returns and updates user-defined analyzers.
Returns all Atlas Search custom analyzers that the specified cluster uses in the specified project. Custom analyzers define the operations to perform to index a field. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Name of the cluster that contains the collection with one or more Atlas Search indexes. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
[
-
{
-
"charFilters":
[
-
{
-
"ignoredTags":
[
-
"string"
],
-
"type":
"htmlStrip"
}
],
-
"name":
"string",
-
"tokenFilters":
[
-
{
-
"originalTokens":
"omit",
-
"type":
"asciiFolding"
}
],
-
"tokenizer":
{
-
"maxGram": 0,
-
"minGram": 0,
-
"type":
"edgeGram"
}
}
]
Updates one or more Atlas Search custom analyzers on the specified cluster. Custom analyzers define the operations to perform to index a field. To use this resource, the requesting API Key must have the Project Data Access Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Name of the cluster that contains the collection with one or more Atlas Search indexes. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Updates one or more Atlas Search custom analyzers on the specified cluster.
|
Array of htmlStrip (object) or icuNormalize (object) or mapping (object)
or persian (object)
Filters that examine text one character at a time and perform filtering operations. |
|
|
name
required
|
string
Human-readable name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:
|
|
Array of asciiFolding (object) or daitchMokotoffSoundex (object) or
edgeGram (object) or icuFolding (object) or icuNormalizer (object)
or length (object) or lowercase (object) or nGram (object) or
regex (object) or reverse (object) or shingle (object) or
snowballStemming (object) or stopword (object) or trim
(object)
Filter that performs operations such as:
|
|
|
required
|
edgeGram (object) or keyword (object) or nGram (object) or
regexCaptureGroup (object) or regexSplit (object) or standard
(object) or uaxUrlEmail (object) or whitespace (object)
Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing. |
[
-
{
-
"charFilters":
[
-
{
-
"ignoredTags":
[
-
"string"
],
-
"type":
"htmlStrip"
}
],
-
"name":
"string",
-
"tokenFilters":
[
-
{
-
"originalTokens":
"omit",
-
"type":
"asciiFolding"
}
],
-
"tokenizer":
{
-
"maxGram": 0,
-
"minGram": 0,
-
"type":
"edgeGram"
}
}
]
[
-
{
-
"charFilters":
[
-
{
-
"ignoredTags":
[
-
"string"
],
-
"type":
"htmlStrip"
}
],
-
"name":
"string",
-
"tokenFilters":
[
-
{
-
"originalTokens":
"omit",
-
"type":
"asciiFolding"
}
],
-
"tokenizer":
{
-
"maxGram": 0,
-
"minGram": 0,
-
"type":
"edgeGram"
}
}
]
Creates one Atlas Search index on the specified collection. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. Only clusters running MongoDB v4.2 or later can use Atlas Search. To use this resource, the requesting API Key must have the Project Data Access Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Name of the cluster that contains the collection on which to create an Atlas Search index. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Creates one Atlas Search index on the specified collection.
| analyzer |
string
Default:
"lucene.standard"
Enum:
"lucene.standard"
"lucene.simple"
"lucene.whitespace"
"lucene.keyword"
"lucene.arabic"
"lucene.armenian"
"lucene.basque"
"lucene.bengali"
"lucene.brazilian"
"lucene.bulgarian"
"lucene.catalan"
"lucene.chinese"
"lucene.cjk"
"lucene.czech"
"lucene.danish"
"lucene.dutch"
"lucene.english"
"lucene.finnish"
"lucene.french"
"lucene.galician"
"lucene.german"
"lucene.greek"
"lucene.hindi"
"lucene.hungarian"
"lucene.indonesian"
"lucene.irish"
"lucene.italian"
"lucene.japanese"
"lucene.korean"
"lucene.kuromoji"
"lucene.latvian"
"lucene.lithuanian"
"lucene.morfologik"
"lucene.nori"
"lucene.norwegian"
"lucene.persian"
"lucene.portuguese"
"lucene.romanian"
"lucene.russian"
"lucene.smartcn"
"lucene.sorani"
"lucene.spanish"
"lucene.swedish"
"lucene.thai"
"lucene.turkish"
"lucene.ukrainian"
Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a term or token. This process, known as tokenization, involves a variety of changes made to the text in fields:
|
|
Array of objects
(analyzers)
List of user-defined methods to convert database field text into searchable words. |
|
|
collectionName
required
|
string
Human-readable label that identifies the collection that contains one or more Atlas Search indexes. |
|
database
required
|
string
Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes. |
|
object
(mappings)
Index specifications for the collection's fields. |
|
|
name
required
|
string
Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique. |
| searchAnalyzer |
string
Default:
"lucene.standard"
Enum:
"lucene.standard"
"lucene.simple"
"lucene.whitespace"
"lucene.keyword"
"lucene.arabic"
"lucene.armenian"
"lucene.basque"
"lucene.bengali"
"lucene.brazilian"
"lucene.bulgarian"
"lucene.catalan"
"lucene.chinese"
"lucene.cjk"
"lucene.czech"
"lucene.danish"
"lucene.dutch"
"lucene.english"
"lucene.finnish"
"lucene.french"
"lucene.galician"
"lucene.german"
"lucene.greek"
"lucene.hindi"
"lucene.hungarian"
"lucene.indonesian"
"lucene.irish"
"lucene.italian"
"lucene.japanese"
"lucene.korean"
"lucene.kuromoji"
"lucene.latvian"
"lucene.lithuanian"
"lucene.morfologik"
"lucene.nori"
"lucene.norwegian"
"lucene.persian"
"lucene.portuguese"
"lucene.romanian"
"lucene.russian"
"lucene.smartcn"
"lucene.sorani"
"lucene.spanish"
"lucene.swedish"
"lucene.thai"
"lucene.turkish"
"lucene.ukrainian"
Method applied to identify words when searching this index. |
|
Array of objects
(Synonym Mapping Definition)
Rule sets that map words to their synonyms in this index. |
{
-
"analyzer":
"lucene.standard",
-
"analyzers":
[
-
{
-
"charFilters":
[
-
{
-
"ignoredTags":
[
-
"string"
],
-
"type":
"htmlStrip"
}
],
-
"name":
"string",
-
"tokenFilters":
[
-
{
-
"originalTokens":
"omit",
-
"type":
"asciiFolding"
}
],
-
"tokenizer":
{
-
"maxGram": 0,
-
"minGram": 0,
-
"type":
"edgeGram"
}
}
],
-
"collectionName":
"string",
-
"database":
"string",
-
"mappings":
{
-
"dynamic":
false,
-
"fields":
{
-
"property1": { },
-
"property2": { }
}
},
-
"name":
"string",
-
"searchAnalyzer":
"lucene.standard",
-
"synonyms":
[
-
{
-
"analyzer":
"lucene.standard",
-
"name":
"string",
-
"source":
{
-
"collection":
"string"
}
}
]
}
{
-
"analyzer":
"lucene.standard",
-
"analyzers":
[
-
{
-
"charFilters":
[
-
{
-
"ignoredTags":
[
-
"string"
],
-
"type":
"htmlStrip"
}
],
-
"name":
"string",
-
"tokenFilters":
[
-
{
-
"originalTokens":
"omit",
-
"type":
"asciiFolding"
}
],
-
"tokenizer":
{
-
"maxGram": 0,
-
"minGram": 0,
-
"type":
"edgeGram"
}
}
],
-
"collectionName":
"string",
-
"database":
"string",
-
"indexID":
"2dc22bf163e2f83527cc3838",
-
"mappings":
{
-
"dynamic":
false,
-
"fields":
{
-
"property1": { },
-
"property2": { }
}
},
-
"name":
"string",
-
"searchAnalyzer":
"lucene.standard",
-
"status":
"IN_PROGRESS",
-
"synonyms":
[
-
{
-
"analyzer":
"lucene.standard",
-
"name":
"string",
-
"source":
{
-
"collection":
"string"
}
}
]
}
Returns all Atlas Search indexes on the specified collection. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Name of the cluster that contains the collection with one or more Atlas Search indexes. |
|
collectionName
required
|
string
Name of the collection that contains one or more Atlas Search indexes. |
|
databaseName
required
|
string
Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
[
-
{
-
"analyzer":
"lucene.standard",
-
"analyzers":
[
-
{
-
"charFilters":
[
-
{
-
"ignoredTags":
[
-
"string"
],
-
"type":
"htmlStrip"
}
],
-
"name":
"string",
-
"tokenFilters":
[
-
{
-
"originalTokens":
"omit",
-
"type":
"asciiFolding"
}
],
-
"tokenizer":
{
-
"maxGram":
0,
-
"minGram":
0,
-
"type":
"edgeGram"
}
}
],
-
"collectionName": "string",
-
"database":
"string",
-
"indexID":
"2dc22bf163e2f83527cc3838",
-
"mappings":
{
-
"dynamic": false,
-
"fields":
{
-
"property1":
{ },
-
"property2":
{ }
}
},
-
"name":
"string",
-
"searchAnalyzer":
"lucene.standard",
-
"status":
"IN_PROGRESS",
-
"synonyms":
[
-
{
-
"analyzer":
"lucene.standard",
-
"name":
"string",
-
"source":
{
-
"collection":
"string"
}
}
]
}
]
Removes one Atlas Search index that you identified with its unique ID. To use this resource, the requesting API Key must have the Project Data Access Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Name of the cluster that contains the database and collection with one or more Application Search indexes. |
|
indexId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the Get All Atlas Search Indexes for a Collection API endpoint to find the IDs of all Atlas Search indexes. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns one Atlas Search index in the specified project. You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Name of the cluster that contains the collection with one or more Atlas Search indexes. |
|
indexId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the Application Search index. Use the Get All Application Search Indexes for a Collection API endpoint to find the IDs of all Application Search indexes. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"analyzer":
"lucene.standard",
-
"analyzers":
[
-
{
-
"charFilters":
[
-
{
-
"ignoredTags":
[
-
"string"
],
-
"type":
"htmlStrip"
}
],
-
"name":
"string",
-
"tokenFilters":
[
-
{
-
"originalTokens":
"omit",
-
"type":
"asciiFolding"
}
],
-
"tokenizer":
{
-
"maxGram": 0,
-
"minGram": 0,
-
"type":
"edgeGram"
}
}
],
-
"collectionName":
"string",
-
"database":
"string",
-
"indexID":
"2dc22bf163e2f83527cc3838",
-
"mappings":
{
-
"dynamic":
false,
-
"fields":
{
-
"property1": { },
-
"property2": { }
}
},
-
"name":
"string",
-
"searchAnalyzer":
"lucene.standard",
-
"status":
"IN_PROGRESS",
-
"synonyms":
[
-
{
-
"analyzer":
"lucene.standard",
-
"name":
"string",
-
"source":
{
-
"collection":
"string"
}
}
]
}
Updates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting API Key must have the Project Data Access Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Name of the cluster that contains the collection whose Atlas Search index to update. |
|
indexId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the Get All Atlas Search Indexes for a Collection API endpoint to find the IDs of all Atlas Search indexes. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Details to update on the Atlas Search index.
| analyzer |
string
Default:
"lucene.standard"
Enum:
"lucene.standard"
"lucene.simple"
"lucene.whitespace"
"lucene.keyword"
"lucene.arabic"
"lucene.armenian"
"lucene.basque"
"lucene.bengali"
"lucene.brazilian"
"lucene.bulgarian"
"lucene.catalan"
"lucene.chinese"
"lucene.cjk"
"lucene.czech"
"lucene.danish"
"lucene.dutch"
"lucene.english"
"lucene.finnish"
"lucene.french"
"lucene.galician"
"lucene.german"
"lucene.greek"
"lucene.hindi"
"lucene.hungarian"
"lucene.indonesian"
"lucene.irish"
"lucene.italian"
"lucene.japanese"
"lucene.korean"
"lucene.kuromoji"
"lucene.latvian"
"lucene.lithuanian"
"lucene.morfologik"
"lucene.nori"
"lucene.norwegian"
"lucene.persian"
"lucene.portuguese"
"lucene.romanian"
"lucene.russian"
"lucene.smartcn"
"lucene.sorani"
"lucene.spanish"
"lucene.swedish"
"lucene.thai"
"lucene.turkish"
"lucene.ukrainian"
Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a term or token. This process, known as tokenization, involves a variety of changes made to the text in fields:
|
|
Array of objects
(analyzers)
List of user-defined methods to convert database field text into searchable words. |
|
|
collectionName
required
|
string
Human-readable label that identifies the collection that contains one or more Atlas Search indexes. |
|
database
required
|
string
Human-readable label that identifies the database that contains the collection with one or more Atlas Search indexes. |
|
object
(mappings)
Index specifications for the collection's fields. |
|
|
name
required
|
string
Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique. |
| searchAnalyzer |
string
Default:
"lucene.standard"
Enum:
"lucene.standard"
"lucene.simple"
"lucene.whitespace"
"lucene.keyword"
"lucene.arabic"
"lucene.armenian"
"lucene.basque"
"lucene.bengali"
"lucene.brazilian"
"lucene.bulgarian"
"lucene.catalan"
"lucene.chinese"
"lucene.cjk"
"lucene.czech"
"lucene.danish"
"lucene.dutch"
"lucene.english"
"lucene.finnish"
"lucene.french"
"lucene.galician"
"lucene.german"
"lucene.greek"
"lucene.hindi"
"lucene.hungarian"
"lucene.indonesian"
"lucene.irish"
"lucene.italian"
"lucene.japanese"
"lucene.korean"
"lucene.kuromoji"
"lucene.latvian"
"lucene.lithuanian"
"lucene.morfologik"
"lucene.nori"
"lucene.norwegian"
"lucene.persian"
"lucene.portuguese"
"lucene.romanian"
"lucene.russian"
"lucene.smartcn"
"lucene.sorani"
"lucene.spanish"
"lucene.swedish"
"lucene.thai"
"lucene.turkish"
"lucene.ukrainian"
Method applied to identify words when searching this index. |
|
Array of objects
(Synonym Mapping Definition)
Rule sets that map words to their synonyms in this index. |
{
-
"analyzer":
"lucene.standard",
-
"analyzers":
[
-
{
-
"charFilters":
[
-
{
-
"ignoredTags":
[
-
"string"
],
-
"type":
"htmlStrip"
}
],
-
"name":
"string",
-
"tokenFilters":
[
-
{
-
"originalTokens":
"omit",
-
"type":
"asciiFolding"
}
],
-
"tokenizer":
{
-
"maxGram": 0,
-
"minGram": 0,
-
"type":
"edgeGram"
}
}
],
-
"collectionName":
"string",
-
"database":
"string",
-
"mappings":
{
-
"dynamic":
false,
-
"fields":
{
-
"property1": { },
-
"property2": { }
}
},
-
"name":
"string",
-
"searchAnalyzer":
"lucene.standard",
-
"synonyms":
[
-
{
-
"analyzer":
"lucene.standard",
-
"name":
"string",
-
"source":
{
-
"collection":
"string"
}
}
]
}
{
-
"analyzer":
"lucene.standard",
-
"analyzers":
[
-
{
-
"charFilters":
[
-
{
-
"ignoredTags":
[
-
"string"
],
-
"type":
"htmlStrip"
}
],
-
"name":
"string",
-
"tokenFilters":
[
-
{
-
"originalTokens":
"omit",
-
"type":
"asciiFolding"
}
],
-
"tokenizer":
{
-
"maxGram": 0,
-
"minGram": 0,
-
"type":
"edgeGram"
}
}
],
-
"collectionName":
"string",
-
"database":
"string",
-
"indexID":
"2dc22bf163e2f83527cc3838",
-
"mappings":
{
-
"dynamic":
false,
-
"fields":
{
-
"property1": { },
-
"property2": { }
}
},
-
"name":
"string",
-
"searchAnalyzer":
"lucene.standard",
-
"status":
"IN_PROGRESS",
-
"synonyms":
[
-
{
-
"analyzer":
"lucene.standard",
-
"name":
"string",
-
"source":
{
-
"collection":
"string"
}
}
]
}
Returns the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"auditAuthorizationSuccess": false,
-
"auditFilter":
"string",
-
"configurationType": "NONE",
-
"enabled":
false
}
Updates the auditing configuration for the specified project. The auditing configuration defines the events that MongoDB Cloud records in the audit log. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Updated auditing configuration for the specified project.
|
auditAuthorizationSuccess
required
|
boolean
Default:
false
Flag that indicates whether someone set auditing to track successful
authentications. This only applies to the
|
|
auditFilter
required
|
string
JSON document that specifies which events to record. Escape any
characters that may prevent parsing, such as single or double
quotes, using a backslash ( |
|
enabled
required
|
boolean
Default:
false
Flag that indicates whether someone enabled database auditing for the specified project. |
{
-
"auditAuthorizationSuccess": false,
-
"auditFilter":
"string",
-
"enabled":
false
}
{
-
"auditAuthorizationSuccess": false,
-
"auditFilter":
"string",
-
"configurationType": "NONE",
-
"enabled":
false
}
Cloud Backups Management - Manages cloud backup snapshots, export buckets and schedules.
Returns all AWS S3 buckets associated with the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"_id":
"d705ef7f03974e8363ffee5d",
-
"bucketName":
"string",
-
"cloudProvider":
"AWS",
-
"iamRoleId":
"3ede41953aba3592851299c1",
-
"links":
[
-
]
}
],
-
"totalCount":
0
}
Grants MongoDB Cloud access to the specified AWS S3 bucket. This enables this bucket to receive Atlas Cloud Backup snapshots. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Grants MongoDB Cloud access to the specified AWS S3 bucket.
| bucketName |
string
Human-readable label that identifies the AWS bucket that the role is authorized to access. |
| cloudProvider |
string
Enum:
"AWS"
"AZURE"
"GCP"
Human-readable label that identifies the cloud provider that stores this snapshot. |
| iamRoleId |
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal character string that identifies the AWS IAM role that MongoDB Cloud uses to access the AWS S3 bucket. |
{
-
"bucketName":
"string",
-
"cloudProvider":
"AWS",
-
"iamRoleId":
"3ede41953aba3592851299c1"
}
{
-
"_id":
"d705ef7f03974e8363ffee5d",
-
"bucketName":
"string",
-
"cloudProvider":
"AWS",
-
"iamRoleId":
"3ede41953aba3592851299c1",
-
"links":
[
-
]
}
Returns one AWS S3 bucket associated with the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
exportBucketId
required
|
string
[ 3 .. 63 ] characters
^((?!xn--)(?!.*-s3alias)[a-z0-9][a-z0-9-]{1,6...
Unique string that identifies the AWS S3 bucket to which you export your snapshots. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"_id":
"d705ef7f03974e8363ffee5d",
-
"bucketName":
"string",
-
"cloudProvider":
"AWS",
-
"iamRoleId":
"3ede41953aba3592851299c1",
-
"links":
[
-
]
}
Returns all Cloud Backup snapshot export jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"components":
[
-
{
-
"replicaSetName":
"string"
}
],
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"customData":
[
-
{
-
"key":
"string",
-
"value":
"string"
}
],
-
"deliveryUrl":
[
-
"string"
],
-
"exportBucketId":
"d705ef7f03974e8363ffee5d",
-
"exportStatus":
{
-
"exportedCollections": 0,
-
"totalCollections": 0
},
-
"finishedAt":
"2019-08-24T14:15:22Z",
-
"id":
"e7cb93f480f357b5139ccf37",
-
"links":
[
-
],
-
"prefix":
"string",
-
"snapshotId":
"78e18e587716102f711a5bca",
-
"state":
"Cancelled"
}
],
-
"totalCount":
0
}
Exports one backup snapshot for dedicated Atlas cluster using Cloud Backups to an AWS bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
|
Array of objects
(ApiAtlasLabelView)
Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes. |
|
|
exportBucketId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal character string that identifies the AWS bucket to which MongoDB Cloud exports the Cloud Backup snapshot. |
|
snapshotId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal character string that identifies the Cloud Backup snasphot to export. |
{
-
"customData":
[
-
{
-
"key":
"string",
-
"value":
"string"
}
],
-
"exportBucketId":
"d705ef7f03974e8363ffee5d",
-
"snapshotId":
"78e18e587716102f711a5bca"
}
{
-
"components":
[
-
{
-
"replicaSetName":
"string"
}
],
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"customData":
[
-
{
-
"key":
"string",
-
"value":
"string"
}
],
-
"deliveryUrl":
[
-
"string"
],
-
"exportBucketId":
"d705ef7f03974e8363ffee5d",
-
"exportStatus":
{
-
"exportedCollections": 0,
-
"totalCollections": 0
},
-
"finishedAt":
"2019-08-24T14:15:22Z",
-
"id":
"e7cb93f480f357b5139ccf37",
-
"links":
[
-
],
-
"prefix":
"string",
-
"snapshotId":
"78e18e587716102f711a5bca",
-
"state":
"Cancelled"
}
Returns one Cloud Backup snapshot export job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
|
exportId
required
|
string
Unique string that identifies the AWS S3 bucket to which you export your snapshots. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"components":
[
-
{
-
"replicaSetName":
"string"
}
],
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"customData":
[
-
{
-
"key":
"string",
-
"value":
"string"
}
],
-
"deliveryUrl":
[
-
"string"
],
-
"exportBucketId":
"d705ef7f03974e8363ffee5d",
-
"exportStatus":
{
-
"exportedCollections": 0,
-
"totalCollections": 0
},
-
"finishedAt":
"2019-08-24T14:15:22Z",
-
"id":
"e7cb93f480f357b5139ccf37",
-
"links":
[
-
],
-
"prefix":
"string",
-
"snapshotId":
"78e18e587716102f711a5bca",
-
"state":
"Cancelled"
}
Returns all cloud backup restore jobs for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster with the restore jobs you want to return. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"cancelled": true,
-
"components":
[
-
{
-
"replicaSetName":
"string"
}
],
-
"deliveryType":
"automated",
-
"deliveryUrl":
[
-
"string"
],
-
"desiredTimestamp":
{
-
"date":
"2019-08-24T14:15:22Z",
-
"increment":
1199145600
},
-
"expired": true,
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"failed": true,
-
"finishedAt":
"2019-08-24T14:15:22Z",
-
"id":
"e7cb93f480f357b5139ccf37",
-
"links":
[
-
],
-
"oplogInc": 1,
-
"oplogTs": 1199145600,
-
"pointInTimeUTCSeconds": 1199145600,
-
"snapshotId":
"78e18e587716102f711a5bca",
-
"targetClusterName":
"string",
-
"targetGroupId":
"ca4d8a18b96b317422974eec",
-
"timestamp":
"2019-08-24T14:15:22Z"
}
],
-
"totalCount":
0
}
Restores one snapshot of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Restores one snapshot of one cluster from the specified project.
|
deliveryType
required
|
string
Enum:
"automated"
"download"
"pointInTime"
Human-readable label that categorizes the restore job to create. |
| oplogInc |
integer
<int32>
>= 1
Oplog operation number from which you want to restore this snapshot.
This number represents the second part of an Oplog timestamp. The
resource returns this parameter when
|
| oplogTs |
integer
<int32>
>= 1199145600
Date and time from which you want to restore this snapshot. This
parameter expresses this timestamp in the number of seconds that
have elapsed since the UNIX epoch. This number represents the first
part of an Oplog timestamp. The resource returns this parameter when
|
| pointInTimeUTCSeconds |
integer
<int32>
>= 1199145600
Date and time from which MongoDB Cloud restored this snapshot. This
parameter expresses this timestamp in the number of seconds that
have elapsed since the UNIX epoch. The resource returns this
parameter when
|
| snapshotId |
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal character string that identifies the snapshot. |
|
targetClusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the target cluster to which the
restore job restores the snapshot. The resource returns this
parameter when |
|
targetGroupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the target project for the specified targetClusterName. |
{
-
"deliveryType":
"automated",
-
"oplogInc":
1,
-
"oplogTs":
1199145600,
-
"pointInTimeUTCSeconds": 1199145600,
-
"snapshotId":
"78e18e587716102f711a5bca",
-
"targetClusterName": "string",
-
"targetGroupId":
"ca4d8a18b96b317422974eec"
}
{
-
"cancelled":
true,
-
"components":
[
-
{
-
"replicaSetName":
"string"
}
],
-
"deliveryType":
"automated",
-
"deliveryUrl":
[
-
"string"
],
-
"desiredTimestamp": {
-
"date":
"2019-08-24T14:15:22Z",
-
"increment": 1199145600
},
-
"expired":
true,
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"failed":
true,
-
"finishedAt":
"2019-08-24T14:15:22Z",
-
"id":
"e7cb93f480f357b5139ccf37",
-
"links":
[
-
],
-
"oplogInc":
1,
-
"oplogTs":
1199145600,
-
"pointInTimeUTCSeconds": 1199145600,
-
"snapshotId":
"78e18e587716102f711a5bca",
-
"targetClusterName": "string",
-
"targetGroupId":
"ca4d8a18b96b317422974eec",
-
"timestamp":
"2019-08-24T14:15:22Z"
}
Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
|
restoreJobId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the restore job to remove. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster with the restore jobs you want to return. |
|
restoreJobId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the restore job to return. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"cancelled":
true,
-
"components":
[
-
{
-
"replicaSetName":
"string"
}
],
-
"deliveryType":
"automated",
-
"deliveryUrl":
[
-
"string"
],
-
"desiredTimestamp": {
-
"date":
"2019-08-24T14:15:22Z",
-
"increment": 1199145600
},
-
"expired":
true,
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"failed":
true,
-
"finishedAt":
"2019-08-24T14:15:22Z",
-
"id":
"e7cb93f480f357b5139ccf37",
-
"links":
[
-
],
-
"oplogInc":
1,
-
"oplogTs":
1199145600,
-
"pointInTimeUTCSeconds": 1199145600,
-
"snapshotId":
"78e18e587716102f711a5bca",
-
"targetClusterName": "string",
-
"targetGroupId":
"ca4d8a18b96b317422974eec",
-
"timestamp":
"2019-08-24T14:15:22Z"
}
Removes all cloud backup schedules for the specified cluster. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"autoExportEnabled": true,
-
"clusterId":
"5faec72692cee15b51eb22a4",
-
"clusterName":
"string",
-
"copySettings":
[
-
{
-
"cloudProvider":
"AWS",
-
"frequencies":
[
-
"HOURLY"
],
-
"regionName":
"string",
-
"replicationSpecId":
"string",
-
"shouldCopyOplogs": true
}
],
-
"export":
{
-
"exportBucketId":
"d705ef7f03974e8363ffee5d",
-
"frequencyType":
"monthly"
},
-
"links":
[
-
],
-
"nextSnapshot":
"2019-08-24T14:15:22Z",
-
"policies":
[
-
{
-
"id":
"stringstringstringstring",
-
"policyItems":
[
-
{
-
"frequencyInterval":
1,
-
"frequencyType":
"DAILY",
-
"id":
"stringstringstringstring",
-
"retentionUnit":
"DAYS",
-
"retentionValue":
0
}
]
}
],
-
"referenceHourOfDay": 0,
-
"referenceMinuteOfHour": 0,
-
"restoreWindowDays": 0,
-
"useOrgAndGroupNamesInExportPrefix": true
}
Returns the cloud backup schedule for the specified cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"autoExportEnabled": true,
-
"clusterId":
"5faec72692cee15b51eb22a4",
-
"clusterName":
"string",
-
"copySettings":
[
-
{
-
"cloudProvider":
"AWS",
-
"frequencies":
[
-
"HOURLY"
],
-
"regionName":
"string",
-
"replicationSpecId":
"string",
-
"shouldCopyOplogs": true
}
],
-
"export":
{
-
"exportBucketId":
"d705ef7f03974e8363ffee5d",
-
"frequencyType":
"monthly"
},
-
"links":
[
-
],
-
"nextSnapshot":
"2019-08-24T14:15:22Z",
-
"policies":
[
-
{
-
"id":
"stringstringstringstring",
-
"policyItems":
[
-
{
-
"frequencyInterval":
1,
-
"frequencyType":
"DAILY",
-
"id":
"stringstringstringstring",
-
"retentionUnit":
"DAYS",
-
"retentionValue":
0
}
]
}
],
-
"referenceHourOfDay": 0,
-
"referenceMinuteOfHour": 0,
-
"restoreWindowDays": 0,
-
"useOrgAndGroupNamesInExportPrefix": true
}
Updates the cloud backup schedule for one cluster within the specified project. This schedule defines when MongoDB Cloud takes scheduled snapshots and how long it stores those snapshots. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Updates the cloud backup schedule for one cluster within the specified project.
Note: In the request body, provide only the fields that you want to update.
| autoExportEnabled |
boolean
Flag that indicates whether MongoDB Cloud automatically exports cloud backup snapshots to the AWS bucket. |
|
Array of objects
(ApiAtlasDiskBackupCopySettingView)
List that contains a document for each copy setting item in the desired backup policy. |
|
|
Array of objects
(ApiDeleteCopiedBackupsView)
List that contains a document for each deleted copy setting whose backup copies you want to delete. |
|
|
object
(export)
Policy for automatically exporting cloud backup snapshots. |
|
|
required
|
Array of objects
(ApiPolicyView)
<= 1 items
Rules set for this backup schedule. |
| referenceHourOfDay |
integer
<int32>
Hour of day in Coordinated Universal Time (UTC) that represents when MongoDB Cloud takes the snapshot. |
| referenceMinuteOfHour |
integer
<int32>
Minute of the referenceHourOfDay that represents when MongoDB Cloud takes the snapshot. |
| restoreWindowDays |
integer
<int32>
Number of previous days that you can restore back to with Continuous Cloud Backup accuracy. You must specify a positive, non-zero integer. This parameter applies to continuous cloud backups only. |
| updateSnapshots |
boolean
Flag that indicates whether to apply the retention changes in the updated backup policy to snapshots that MongoDB Cloud took previously. |
| useOrgAndGroupNamesInExportPrefix |
boolean
Flag that indicates whether to use organization and project names instead of organization and project UUIDs in the path to the metadata files that MongoDB Cloud uploads to your AWS bucket. |
{
-
"autoExportEnabled": true,
-
"copySettings":
[
-
{
-
"cloudProvider":
"AWS",
-
"frequencies":
[
-
"HOURLY"
],
-
"regionName":
"string",
-
"replicationSpecId":
"string",
-
"shouldCopyOplogs": true
}
],
-
"deleteCopiedBackups": [
-
{
-
"cloudProvider":
"AWS",
-
"regionName":
"string",
-
"replicationSpecId":
"string"
}
],
-
"export":
{
-
"exportBucketId":
"d705ef7f03974e8363ffee5d",
-
"frequencyType":
"monthly"
},
-
"policies":
[
-
{
-
"id":
"stringstringstringstring",
-
"policyItems":
[
-
{
-
"frequencyInterval":
1,
-
"frequencyType":
"DAILY",
-
"id":
"stringstringstringstring",
-
"retentionUnit":
"DAYS",
-
"retentionValue":
0
}
]
}
],
-
"referenceHourOfDay": 0,
-
"referenceMinuteOfHour": 0,
-
"restoreWindowDays": 0,
-
"updateSnapshots": true,
-
"useOrgAndGroupNamesInExportPrefix": true
}
{
-
"autoExportEnabled": true,
-
"clusterId":
"5faec72692cee15b51eb22a4",
-
"clusterName":
"string",
-
"copySettings":
[
-
{
-
"cloudProvider":
"AWS",
-
"frequencies":
[
-
"HOURLY"
],
-
"regionName":
"string",
-
"replicationSpecId":
"string",
-
"shouldCopyOplogs": true
}
],
-
"export":
{
-
"exportBucketId":
"d705ef7f03974e8363ffee5d",
-
"frequencyType":
"monthly"
},
-
"links":
[
-
],
-
"nextSnapshot":
"2019-08-24T14:15:22Z",
-
"policies":
[
-
{
-
"id":
"stringstringstringstring",
-
"policyItems":
[
-
{
-
"frequencyInterval":
1,
-
"frequencyType":
"DAILY",
-
"id":
"stringstringstringstring",
-
"retentionUnit":
"DAYS",
-
"retentionValue":
0
}
]
}
],
-
"referenceHourOfDay": 0,
-
"referenceMinuteOfHour": 0,
-
"restoreWindowDays": 0,
-
"useOrgAndGroupNamesInExportPrefix": true
}
Returns all snapshots of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"cloudProvider":
"AWS",
-
"copyRegions":
[
-
"string"
],
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"description":
"string",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"frequencyType":
"hourly",
-
"id":
"78e18e587716102f711a5bca",
-
"links":
[
-
],
-
"masterKeyUUID":
"72659f08-8b3c-4913-bb4e-a8a68e036502",
-
"mongodVersion":
"string",
-
"policyItems":
[
-
"f9fd98556fbe1a4eb3a396cb"
],
-
"replicaSetName":
"string",
-
"snapshotType":
"onDemand",
-
"status":
"queued",
-
"storageSizeBytes": 0,
-
"type":
"REPLICA_SET"
}
],
-
"totalCount":
0
}
Takes one on-demand snapshot for the specified cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Takes one on-demand snapshot.
| description |
string
Human-readable phrase or sentence that explains the purpose of the
snapshot. The resource returns this parameter when
|
| retentionInDays |
integer
<int32>
>= 1
Number of days that MongoDB Cloud should retain the on-demand snapshot. Must be at least 1 |
{
-
"description":
"string",
-
"retentionInDays": 1
}
{
-
"cloudProvider": "AWS",
-
"copyRegions":
[
-
"string"
],
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"description":
"string",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"frequencyType": "hourly",
-
"id":
"78e18e587716102f711a5bca",
-
"links":
[
-
],
-
"masterKeyUUID":
"72659f08-8b3c-4913-bb4e-a8a68e036502",
-
"mongodVersion": "string",
-
"policyItems":
[
-
"f9fd98556fbe1a4eb3a396cb"
],
-
"replicaSetName": "string",
-
"snapshotType":
"onDemand",
-
"status":
"queued",
-
"storageSizeBytes": 0,
-
"type":
"REPLICA_SET"
}
Removes one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
|
snapshotId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the desired snapshot. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) Cannot find resource
AWS",
-
"error":
404,
-
"errorCode":
"RESOURCE_NOT_FOUND",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Not Found"
}
Returns one snapshot of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
|
snapshotId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the desired snapshot. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"description":
"string",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"frequencyType":
"hourly",
-
"id":
"78e18e587716102f711a5bca",
-
"links":
[
-
],
-
"masterKeyUUID":
"72659f08-8b3c-4913-bb4e-a8a68e036502",
-
"members":
[
-
{
-
"cloudProvider":
"AWS",
-
"id":
"78e18e587716102f711a5bca",
-
"replicaSetName":
"string"
}
],
-
"mongodVersion":
"string",
-
"policyItems":
[
-
"f9fd98556fbe1a4eb3a396cb"
],
-
"snapshotIds":
[
-
"78e18e587716102f711a5bca"
],
-
"snapshotType":
"onDemand",
-
"status":
"queued",
-
"storageSizeBytes": 0,
-
"type":
"REPLICA_SET"
}
Returns all snapshots of one sharded cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"description":
"string",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"frequencyType":
"hourly",
-
"id":
"78e18e587716102f711a5bca",
-
"links":
[
-
],
-
"masterKeyUUID":
"72659f08-8b3c-4913-bb4e-a8a68e036502",
-
"members":
[
-
{
-
"cloudProvider":
"AWS",
-
"id":
"78e18e587716102f711a5bca",
-
"replicaSetName":
"string"
}
],
-
"mongodVersion":
"string",
-
"policyItems":
[
-
"f9fd98556fbe1a4eb3a396cb"
],
-
"snapshotIds":
[
-
"78e18e587716102f711a5bca"
],
-
"snapshotType":
"onDemand",
-
"status":
"queued",
-
"storageSizeBytes": 0,
-
"type":
"REPLICA_SET"
}
],
-
"totalCount":
0
}
Removes the specified snapshot. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
|
snapshotId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the desired snapshot. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns one snapshot from the specified cluster. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
|
snapshotId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the desired snapshot. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"cloudProvider":
"AWS",
-
"copyRegions":
[
-
"string"
],
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"description":
"string",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"frequencyType":
"hourly",
-
"id":
"78e18e587716102f711a5bca",
-
"links":
[
-
],
-
"masterKeyUUID":
"72659f08-8b3c-4913-bb4e-a8a68e036502",
-
"mongodVersion":
"string",
-
"policyItems":
[
-
"f9fd98556fbe1a4eb3a396cb"
],
-
"replicaSetName":
"string",
-
"snapshotType":
"onDemand",
-
"status":
"queued",
-
"storageSizeBytes": 0,
-
"type":
"REPLICA_SET"
}
Changes the expiration date for one cloud backup snapshot for one cluster in the specified project. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
|
snapshotId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the desired snapshot. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.
|
retentionUnit
required
|
string
Enum:
"DAYS"
"WEEKS"
"MONTHS"
Quantity of time in which MongoDB Cloud measures snapshot retention. |
|
retentionValue
required
|
integer
<int32>
Number that indicates the amount of days, weeks, or months that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. If the hourly policy item specifies a retention of two days, specify two days or greater for the retention of the weekly policy item. |
{
-
"retentionUnit":
"DAYS",
-
"retentionValue":
5
}
{
-
"cloudProvider":
"AWS",
-
"copyRegions":
[
-
"string"
],
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"description":
"string",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"frequencyType":
"hourly",
-
"id":
"78e18e587716102f711a5bca",
-
"links":
[
-
],
-
"masterKeyUUID":
"72659f08-8b3c-4913-bb4e-a8a68e036502",
-
"mongodVersion":
"string",
-
"policyItems":
[
-
"f9fd98556fbe1a4eb3a396cb"
],
-
"replicaSetName":
"string",
-
"snapshotType":
"onDemand",
-
"status":
"queued",
-
"storageSizeBytes": 0,
-
"type":
"REPLICA_SET"
}
Returns all restore jobs for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the serverless instance. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"cancelled": true,
-
"deliveryType":
"automated",
-
"deliveryUrl":
[
-
"string"
],
-
"desiredTimestamp":
{
-
"date":
"2019-08-24T14:15:22Z",
-
"increment":
1199145600
},
-
"expired": true,
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"failed": true,
-
"finishedAt":
"2019-08-24T14:15:22Z",
-
"id":
"e7cb93f480f357b5139ccf37",
-
"snapshotId":
"78e18e587716102f711a5bca",
-
"targetClusterName":
"string",
-
"targetGroupId":
"ca4d8a18b96b317422974eec",
-
"timestamp":
"2019-08-24T14:15:22Z"
}
],
-
"totalCount":
0
}
Restores one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the serverless instance whose snapshot you want to restore. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Restores one snapshot of one serverless instance from the specified project.
|
deliveryType
required
|
string
Enum:
"automated"
"download"
"pointInTime"
Human-readable label that categorizes the restore job to create. |
| snapshotId |
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal character string that identifies the snapshot. |
|
targetClusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the target cluster to which the
restore job restores the snapshot. The resource returns this
parameter when |
|
targetGroupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the target project for the specified targetClusterName. |
{
-
"deliveryType":
"automated",
-
"snapshotId":
"78e18e587716102f711a5bca",
-
"targetClusterName": "string",
-
"targetGroupId":
"ca4d8a18b96b317422974eec"
}
{
-
"cancelled":
true,
-
"deliveryType":
"automated",
-
"deliveryUrl":
[
-
"string"
],
-
"desiredTimestamp": {
-
"date":
"2019-08-24T14:15:22Z",
-
"increment": 1199145600
},
-
"expired":
true,
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"failed":
true,
-
"finishedAt":
"2019-08-24T14:15:22Z",
-
"id":
"e7cb93f480f357b5139ccf37",
-
"snapshotId":
"78e18e587716102f711a5bca",
-
"targetClusterName": "string",
-
"targetGroupId":
"ca4d8a18b96b317422974eec",
-
"timestamp":
"2019-08-24T14:15:22Z"
}
Returns one restore job for one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the serverless instance. |
|
restoreJobId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the restore job to return. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"cancelled":
true,
-
"deliveryType":
"automated",
-
"deliveryUrl":
[
-
"string"
],
-
"desiredTimestamp": {
-
"date":
"2019-08-24T14:15:22Z",
-
"increment": 1199145600
},
-
"expired":
true,
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"failed":
true,
-
"finishedAt":
"2019-08-24T14:15:22Z",
-
"id":
"e7cb93f480f357b5139ccf37",
-
"snapshotId":
"78e18e587716102f711a5bca",
-
"targetClusterName": "string",
-
"targetGroupId":
"ca4d8a18b96b317422974eec",
-
"timestamp":
"2019-08-24T14:15:22Z"
}
Returns all snapshots of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the serverless instance. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"description":
"string",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"frequencyType":
"hourly",
-
"id":
"78e18e587716102f711a5bca",
-
"mongodVersion":
"5.0.3",
-
"serverlessInstanceName":
"string",
-
"snapshotType":
"onDemand",
-
"status":
"queued",
-
"storageSizeBytes": 0
}
],
-
"totalCount":
0
}
Returns one snapshot of one serverless instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the serverless instance. |
|
snapshotId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
78e18e587716102f711a5bca
Unique 24-hexadecimal digit string that identifies the desired snapshot. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"description":
"string",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"frequencyType":
"hourly",
-
"id":
"78e18e587716102f711a5bca",
-
"mongodVersion":
"5.0.3",
-
"serverlessInstanceName": "string",
-
"snapshotType":
"onDemand",
-
"status":
"queued",
-
"storageSizeBytes": 0
}
Migrate one cluster that Cloud or Ops Manager manages to MongoDB Atlas.
Please make sure to validate your migration before initiating it.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
One migration to be created.
|
required
|
object
(Destination)
Document that describes the destination of the migration. |
|
dropEnabled
required
|
boolean
Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts. |
|
migrationHosts
required
|
Array of strings
= 1 items
List of migration hosts used for this migration. |
|
required
|
object
(Source)
Document that describes the source of the migration. |
{
-
"destination":
{
-
"clusterName": "string",
-
"groupId":
"9b43a5b329223c3a1591a678",
-
"hostnameSchemaType": "PUBLIC",
-
"privateLinkId":
"string"
},
-
"dropEnabled":
true,
-
"migrationHosts":
[
-
"vm001.example.com"
],
-
"source":
{
-
"caCertificatePath": "string",
-
"clusterName": "string",
-
"groupId":
"9b43a5b329223c3a1591a678",
-
"managedAuthentication": true,
-
"password":
"string",
-
"ssl":
true,
-
"username":
"string"
}
}
{
-
"_id":
"6296fb4c7c7aa997cf94e9a8",
-
"lagTimeSeconds":
0,
-
"migrationHosts":
[
-
"vm001.example.com"
],
-
"readyForCutover": true,
-
"status":
"NEW"
}
Check whether the provided credentials, available disk space, MongoDB versions, and so on meet the requirements of the migration request. If the check passes, the migration can proceed.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
One migration to be validated.
|
required
|
object
(Destination)
Document that describes the destination of the migration. |
|
dropEnabled
required
|
boolean
Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts. |
|
migrationHosts
required
|
Array of strings
= 1 items
List of migration hosts used for this migration. |
|
required
|
object
(Source)
Document that describes the source of the migration. |
{
-
"destination":
{
-
"clusterName": "string",
-
"groupId":
"9b43a5b329223c3a1591a678",
-
"hostnameSchemaType": "PUBLIC",
-
"privateLinkId":
"string"
},
-
"dropEnabled":
true,
-
"migrationHosts":
[
-
"vm001.example.com"
],
-
"source":
{
-
"caCertificatePath": "string",
-
"clusterName": "string",
-
"groupId":
"9b43a5b329223c3a1591a678",
-
"managedAuthentication": true,
-
"password":
"string",
-
"ssl":
true,
-
"username":
"string"
}
}
{
-
"_id":
{ },
-
"errorMessage":
"string",
-
"groupId":
"ca4d8a18b96b317422974eec",
-
"sourceGroupId":
"32b6e34b3d91647abb20e7b8",
-
"status":
"PENDING"
}
Return the status of one migration validation job.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
validationId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
507f1f77bcf86cd799439011
Unique 24-hexadecimal digit string that identifies the validation job. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"_id":
{ },
-
"errorMessage":
"string",
-
"groupId":
"ca4d8a18b96b317422974eec",
-
"sourceGroupId":
"32b6e34b3d91647abb20e7b8",
-
"status":
"PENDING"
}
Return details of one cluster migration job.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
liveMigrationId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
6296fb4c7c7aa997cf94e9a8
Unique 24-hexadecimal digit string that identifies the migration. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"_id":
"6296fb4c7c7aa997cf94e9a8",
-
"lagTimeSeconds":
0,
-
"migrationHosts":
[
-
"vm001.example.com"
],
-
"readyForCutover": true,
-
"status":
"NEW"
}
Cut over the migrated cluster to MongoDB Cloud. Confirm when the cut over completes. When the cut over completes, MongoDB Cloud completes the live migration process and stops synchronizing with the source cluster.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
liveMigrationId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
6296fb4c7c7aa997cf94e9a8
Unique 24-hexadecimal digit string that identifies the migration. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"_id":
{ },
-
"errorMessage":
"string",
-
"groupId":
"ca4d8a18b96b317422974eec",
-
"sourceGroupId":
"32b6e34b3d91647abb20e7b8",
-
"status":
"PENDING"
}
Return all projects that you can migrate to the specified organization.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
[
-
{
-
"deployments":
[
-
{
-
"agentVersion":
"string",
-
"clusterId":
"5faec72692cee15b51eb22a4",
-
"dbSizeBytes": 8192,
-
"featureCompatibilityVersion":
"string",
-
"managed": true,
-
"mongoDBVersion":
"string",
-
"name":
"Project X sharded
cluster",
-
"oplogSizeMB": 3,
-
"sharded": true,
-
"shardsSize": 3,
-
"tlsEnabled": true
}
],
-
"migrationHosts":
[
-
"string"
],
-
"name":
"string",
-
"projectId":
"32b6e34b3d91647abb20e7b8"
}
]
Remove one organization link and its associated public API key.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Create one link-token that contains all the information required to complete the link.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| accessListIps |
Array of strings
|
{
-
"accessListIps":
[
-
"string"
]
}
{
-
"linkToken":
"string"
}
Returns all Amazon Web Services (AWS) Identity and Access Management (IAM) roles with access to the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"awsIamRoles":
[
-
{
-
"providerName":
"AWS",
-
"atlasAWSAccountArn":
"arn:aws:iam::772401394250:role/my-test-aws-role",
-
"atlasAssumedRoleExternalId":
"24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
-
"authorizedDate":
"2019-08-24T14:15:22Z",
-
"createdDate":
"2019-08-24T14:15:22Z",
-
"featureUsages":
[
-
{
-
"featureType":
"ATLAS_DATA_LAKE"
}
],
-
"iamAssumedRoleArn":
"arn:aws:iam::123456789012:root",
-
"roleId":
"1ffa0028ed80f089383c05bf"
}
]
}
Creates one Amazon Web Services (AWS) Identity and Access Management (IAM) role. Some MongoDB Cloud features use AWS IAM roles for authentication. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
After a successful request to this API endpoint, you can add the atlasAWSAccountArn and atlasAssumedRoleExternalId values to the trust policy in your AWS console to create an IAM Assumed Amazon Resource Name (ARN).
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Creates one AWS IAM role.
|
providerName
required
|
string
Human-readable label that identifies the cloud provider of the role. |
| iamAssumedRoleArn |
string
[ 20 .. 2048 ] characters
Amazon Resource Name (ARN) that identifies the Amazon Web Services (AWS) Identity and Access Management (IAM) role that MongoDB Cloud assumes when it accesses resources in your AWS account. |
{
-
"providerName":
"AWS",
-
"iamAssumedRoleArn":
"arn:aws:iam::123456789012:root"
}
{
-
"providerName":
"AWS",
-
"atlasAWSAccountArn":
"arn:aws:iam::772401394250:role/my-test-aws-role",
-
"atlasAssumedRoleExternalId":
"24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
-
"authorizedDate":
"2019-08-24T14:15:22Z",
-
"createdDate":
"2019-08-24T14:15:22Z",
-
"featureUsages":
[
-
{
-
"featureType":
"ATLAS_DATA_LAKE"
}
],
-
"iamAssumedRoleArn":
"arn:aws:iam::123456789012:root",
-
"roleId":
"1ffa0028ed80f089383c05bf"
}
Returns the Amazon Web Services (AWS) Identity and Access Management (IAM) role with the specified id and with access to the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
roleId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the role. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"awsIamRoles":
[
-
{
-
"providerName":
"AWS",
-
"atlasAWSAccountArn":
"arn:aws:iam::772401394250:role/my-test-aws-role",
-
"atlasAssumedRoleExternalId":
"24be57ae-3c7b-4f00-b2d8-8ad523d5bd8d",
-
"authorizedDate":
"2019-08-24T14:15:22Z",
-
"createdDate":
"2019-08-24T14:15:22Z",
-
"featureUsages":
[
-
{
-
"featureType":
"ATLAS_DATA_LAKE"
}
],
-
"iamAssumedRoleArn":
"arn:aws:iam::123456789012:root",
-
"roleId":
"1ffa0028ed80f089383c05bf"
}
]
}
Ends a cluster outage simulation.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster that is undergoing outage simulation. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"clusterName":
"string",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"63599c987d469e386156afcb",
-
"outageFilters":
[
-
{
-
"cloudProvider":
"AWS",
-
"regionName":
"string",
-
"type":
"REGION"
}
],
-
"startRequestDate":
"2022-01-01T00:00:00Z",
-
"state":
"START_REQUESTED"
}
Returns one outage simulation for one cluster.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster that is undergoing outage simulation. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"clusterName":
"string",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"63599c987d469e386156afcb",
-
"outageFilters":
[
-
{
-
"cloudProvider":
"AWS",
-
"regionName":
"string",
-
"type":
"REGION"
}
],
-
"startRequestDate":
"2022-01-01T00:00:00Z",
-
"state":
"START_REQUESTED"
}
Starts a cluster outage simulation.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster to undergo an outage simulation. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Describes the outage simulation.
|
Array of objects
(ApiAtlasClusterOutageSimulationOutageFilterView)
non-empty
List of settings that specify the type of cluster outage simulation. |
{
-
"outageFilters":
[
-
{
-
"cloudProvider":
"AWS",
-
"regionName":
"string",
-
"type":
"REGION"
}
]
}
{
-
"clusterName":
"string",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"63599c987d469e386156afcb",
-
"outageFilters":
[
-
{
-
"cloudProvider":
"AWS",
-
"regionName":
"string",
-
"type":
"REGION"
}
],
-
"startRequestDate":
"2022-01-01T00:00:00Z",
-
"state":
"START_REQUESTED"
}
Returns the details for all clusters in all projects to which you have access. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To use this resource, the requesting API Key can have any cluster-level role. This resource doesn't require the API Key to have an Access List.
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"clusters":
[
-
{
-
"alertCount":
0,
-
"authEnabled":
true,
-
"availability":
"available",
-
"backupEnabled":
true,
-
"clusterId":
"stringstringstringstring",
-
"dataSizeBytes":
0,
-
"name":
"string",
-
"nodeCount":
0,
-
"sslEnabled":
true,
-
"type":
"REPLICA_SET",
-
"versions":
[
-
"string"
]
}
],
-
"groupId":
"stringstringstringstring",
-
"groupName":
"string",
-
"orgId":
"stringstringstringstring",
-
"orgName":
"string",
-
"planType":
"string",
-
"tags":
[
-
"string"
]
}
],
-
"totalCount":
0
}
Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To return multi-cloud clusters, use Get All Advanced Clusters. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"autoScaling":
{
-
"compute":
{
-
"enabled":
true,
-
"scaleDownEnabled":
true
},
-
"diskGBEnabled": true
},
-
"backupEnabled": true,
-
"biConnector":
{
-
"enabled": true,
-
"readPreference":
"PRIMARY"
},
-
"clusterType":
"REPLICASET",
-
"connectionStrings":
{
-
"awsPrivateLink":
{
-
"property1":
"string",
-
"property2":
"string"
},
-
"awsPrivateLinkSrv":
{
-
"property1":
"string",
-
"property2":
"string"
},
-
"private":
"string",
-
"privateEndpoint":
[
-
{
-
"connectionString":
"string",
-
"endpoints":
[
-
{
-
"endpointId":
"string",
-
"providerName":
"AWS",
-
"region":
"string"
}
],
-
"srvConnectionString":
"string",
-
"type":
"MONGOD"
}
],
-
"privateSrv":
"string",
-
"standard":
"string",
-
"standardSrv":
"string"
},
-
"createDate":
"2019-08-24T14:15:22Z",
-
"diskSizeGB": 10,
-
"encryptionAtRestProvider":
"NONE",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"5faec72692cee15b51eb22a4",
-
"labels":
[
-
{
-
"key":
"string",
-
"value":
"string"
}
],
-
"links":
[
-
],
-
"mongoDBMajorVersion":
"3.6",
-
"mongoDBVersion":
"string",
-
"mongoURI":
"string",
-
"mongoURIUpdated":
"2019-08-24T14:15:22Z",
-
"mongoURIWithOptions":
"string",
-
"name":
"string",
-
"numShards": 1,
-
"paused": true,
-
"pitEnabled": true,
-
"providerBackupEnabled": true,
-
"providerSettings":
{
-
"providerName":
"string",
-
"autoScaling":
{
-
"compute":
{
-
"maxInstanceSize":
"M10",
-
"minInstanceSize":
"M10"
}
},
-
"diskIOPS": 0,
-
"encryptEBSVolume": true,
-
"instanceSizeName":
"M10",
-
"regionName":
"US_GOV_WEST_1",
-
"volumeType":
"STANDARD"
},
-
"replicationFactor": 3,
-
"replicationSpec":
{
-
"property1":
{
-
"analyticsNodes":
0,
-
"electableNodes":
0,
-
"priority":
7,
-
"readOnlyNodes":
0
},
-
"property2":
{
-
"analyticsNodes":
0,
-
"electableNodes":
0,
-
"priority":
7,
-
"readOnlyNodes":
0
}
},
-
"replicationSpecs":
[
-
{
-
"id":
"6492cb3770e674ece4e89b41",
-
"numShards":
1,
-
"regionsConfig":
{
-
"property1":
{
-
"analyticsNodes":
0,
-
"electableNodes":
0,
-
"priority":
7,
-
"readOnlyNodes":
0
},
-
"property2":
{
-
"analyticsNodes":
0,
-
"electableNodes":
0,
-
"priority":
7,
-
"readOnlyNodes":
0
}
},
-
"zoneName":
"string"
}
],
-
"rootCertType":
"ISRGROOTX1",
-
"srvAddress":
"string",
-
"stateName":
"IDLE",
-
"terminationProtectionEnabled": false,
-
"versionReleaseSystem":
"LTS"
}
],
-
"totalCount":
0
}
Creates one cluster in the specific project. Clusters contain a group of hosts that maintain the same data set. This resource does not create multi-cloud clusters. To create a multi-cloud cluster, use Create One Advanced Cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Details to create for one cluster in the specified project.
|
object
(Automatic Cluster Scaling Settings)
Range of instance sizes to which your cluster can scale. |
|
| backupEnabled |
boolean
Flag that indicates whether the cluster can perform backups. If set
to |
|
object
(MongoDB Connector for Business Intelligence Settings)
Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster. |
|
| clusterType |
string
Enum:
"REPLICASET"
"SHARDED"
"GEOSHARDED"
Configuration of nodes that comprise the cluster. |
| diskSizeGB |
number
<double>
[ 10 .. 4096 ]
Storage capacity that the host's root volume possesses expressed in gigabytes. Increase this number to add capacity. MongoDB Cloud requires this parameter if you set replicationSpecs. If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. |
| encryptionAtRestProvider |
string
Enum:
"NONE"
"AWS"
"AZURE"
"GCP"
Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster. |
|
Array of objects
(Component Label)
Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels. |
|
| mongoDBMajorVersion |
string
Default:
"4.4"
Enum:
"3.6"
"4.0"
"4.2"
"4.4"
"5.0"
Major MongoDB version of the cluster. MongoDB Cloud deploys the cluster with the latest stable release of the specified version. |
| mongoDBVersion |
string([\d]+\.[\d]+\.[\d]+)
Version of MongoDB that the cluster runs. |
| name |
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| numShards |
integer
<int32>
[ 1 .. 50 ]
Default:
1
Number of shards up to 50 to deploy for a sharded cluster. The
resource returns |
| paused |
boolean
Flag that indicates whether the cluster is paused. |
| pitEnabled |
boolean
Flag that indicates whether the cluster uses continuous cloud backups. |
| providerBackupEnabled |
boolean
Flag that indicates whether the M10 or higher cluster can perform
Cloud Backups. If set to |
|
object
(Cloud Service Provider Settings for a Cluster)
Group of cloud provider settings that configure the provisioned MongoDB hosts. |
|
| replicationFactor |
integer
<int32>
Deprecated
Default:
3
Enum:
3
5
7
Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use replicationSpecs instead. |
|
object
(Region Configuration)
Deprecated
Physical location where MongoDB Cloud provisions cluster nodes. |
|
|
Array of objects
(ApiAtlasLegacyReplicationSpecView)
List of settings that configure your cluster regions.
|
|
| rootCertType |
string
Default:
"ISRGROOTX1"
Value:
"ISRGROOTX1"
Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group. |
| terminationProtectionEnabled |
boolean
Default:
false
Flag that indicates whether termination protection is enabled on the
cluster. If set to |
| versionReleaseSystem |
string
Default:
"LTS"
Enum:
"LTS"
"CONTINUOUS"
Method by which the cluster maintains the MongoDB versions. If value
is |
{
-
"autoScaling":
{
-
"compute":
{
-
"enabled": true,
-
"scaleDownEnabled": true
},
-
"diskGBEnabled": true
},
-
"backupEnabled":
true,
-
"biConnector":
{
-
"enabled":
true,
-
"readPreference":
"PRIMARY"
},
-
"clusterType":
"REPLICASET",
-
"diskSizeGB":
10,
-
"encryptionAtRestProvider": "NONE",
-
"labels":
[
-
{
-
"key":
"string",
-
"value":
"string"
}
],
-
"mongoDBMajorVersion": "3.6",
-
"mongoDBVersion":
"string",
-
"name":
"string",
-
"numShards":
1,
-
"paused":
true,
-
"pitEnabled":
true,
-
"providerBackupEnabled": true,
-
"providerSettings": {
-
"providerName": "string",
-
"autoScaling":
{
-
"compute":
{
-
"maxInstanceSize":
"M10",
-
"minInstanceSize":
"M10"
}
},
-
"diskIOPS":
0,
-
"encryptEBSVolume": true,
-
"instanceSizeName": "M10",
-
"regionName":
"US_GOV_WEST_1",
-
"volumeType":
"STANDARD"
},
-
"replicationFactor": 3,
-
"replicationSpec": {
-
"property1":
{
-
"analyticsNodes": 0,
-
"electableNodes": 0,
-
"priority": 7,
-
"readOnlyNodes": 0
},
-
"property2":
{
-
"analyticsNodes": 0,
-
"electableNodes": 0,
-
"priority": 7,
-
"readOnlyNodes": 0
}
},
-
"replicationSpecs": [
-
{
-
"id":
"6492cb3770e674ece4e89b41",
-
"numShards": 1,
-
"regionsConfig":
{
-
"property1":
{
-
"analyticsNodes":
0,
-
"electableNodes":
0,
-
"priority":
7,
-
"readOnlyNodes":
0
},
-
"property2":
{
-
"analyticsNodes":
0,
-
"electableNodes":
0,
-
"priority":
7,
-
"readOnlyNodes":
0
}
},
-
"zoneName":
"string"
}
],
-
"rootCertType":
"ISRGROOTX1",
-
"terminationProtectionEnabled": false,
-
"versionReleaseSystem": "LTS"
}
{
-
"autoScaling":
{
-
"compute":
{
-
"enabled": true,
-
"scaleDownEnabled": true
},
-
"diskGBEnabled": true
},
-
"backupEnabled":
true,
-
"biConnector":
{
-
"enabled":
true,
-
"readPreference":
"PRIMARY"
},
-
"clusterType":
"REPLICASET",
-
"connectionStrings": {
-
"awsPrivateLink":
{
-
"property1":
"string",
-
"property2":
"string"
},
-
"awsPrivateLinkSrv":
{
-
"property1":
"string",
-
"property2":
"string"
},
-
"private":
"string",
-
"privateEndpoint":
[
-
{
-
"connectionString":
"string",
-
"endpoints":
[
-
{
-
"endpointId":
"string",
-
"providerName":
"AWS",
-
"region":
"string"
}
],
-
"srvConnectionString":
"string",
-
"type":
"MONGOD"
}
],
-
"privateSrv": "string",
-
"standard":
"string",
-
"standardSrv":
"string"
},
-
"createDate":
"2019-08-24T14:15:22Z",
-
"diskSizeGB":
10,
-
"encryptionAtRestProvider": "NONE",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"5faec72692cee15b51eb22a4",
-
"labels":
[
-
{
-
"key":
"string",
-
"value":
"string"
}
],
-
"links":
[
-
],
-
"mongoDBMajorVersion": "3.6",
-
"mongoDBVersion":
"string",
-
"mongoURI":
"string",
-
"mongoURIUpdated":
"2019-08-24T14:15:22Z",
-
"mongoURIWithOptions": "string",
-
"name":
"string",
-
"numShards":
1,
-
"paused":
true,
-
"pitEnabled":
true,
-
"providerBackupEnabled": true,
-
"providerSettings": {
-
"providerName": "string",
-
"autoScaling":
{
-
"compute":
{
-
"maxInstanceSize":
"M10",
-
"minInstanceSize":
"M10"
}
},
-
"diskIOPS":
0,
-
"encryptEBSVolume": true,
-
"instanceSizeName": "M10",
-
"regionName":
"US_GOV_WEST_1",
-
"volumeType":
"STANDARD"
},
-
"replicationFactor": 3,
-
"replicationSpec": {
-
"property1":
{
-
"analyticsNodes": 0,
-
"electableNodes": 0,
-
"priority": 7,
-
"readOnlyNodes": 0
},
-
"property2":
{
-
"analyticsNodes": 0,
-
"electableNodes": 0,
-
"priority": 7,
-
"readOnlyNodes": 0
}
},
-
"replicationSpecs": [
-
{
-
"id":
"6492cb3770e674ece4e89b41",
-
"numShards": 1,
-
"regionsConfig":
{
-
"property1":
{
-
"analyticsNodes":
0,
-
"electableNodes":
0,
-
"priority":
7,
-
"readOnlyNodes":
0
},
-
"property2":
{
-
"analyticsNodes":
0,
-
"electableNodes":
0,
-
"priority":
7,
-
"readOnlyNodes":
0
}
},
-
"zoneName":
"string"
}
],
-
"rootCertType":
"ISRGROOTX1",
-
"srvAddress":
"string",
-
"stateName":
"IDLE",
-
"terminationProtectionEnabled": false,
-
"versionReleaseSystem": "LTS"
}
Returns the list of regions available for the specified cloud provider at the specified tier. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| providers |
Array of strings
Cloud providers whose regions to retrieve. When you specify multiple providers, the response can return only tiers and regions that support multi-cloud clusters. |
| tier |
string
Cluster tier for which to retrieve the regions. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"instanceSizes":
[
-
{
-
"availableRegions":
[
-
{
-
"default":
true,
-
"name":
"string"
}
],
-
"name":
"string"
}
],
-
"provider":
"AWS"
}
],
-
"totalCount":
0
}
Upgrade a shared-tier cluster in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. This resource doesn't require the API key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Details of the shared-tier cluster upgrade in the specified project.
|
object
(Automatic Cluster Scaling Settings)
Range of instance sizes to which your cluster can scale. |
|
| backupEnabled |
boolean
Flag that indicates whether the cluster can perform backups. If set
to |
|
object
(MongoDB Connector for Business Intelligence Settings)
Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster. |
|
| clusterType |
string
Enum:
"REPLICASET"
"SHARDED"
"GEOSHARDED"
Configuration of nodes that comprise the cluster. |
| diskSizeGB |
number
<double>
[ 10 .. 4096 ]
Storage capacity that the host's root volume possesses expressed in gigabytes. Increase this number to add capacity. MongoDB Cloud requires this parameter if you set replicationSpecs. If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. |
| encryptionAtRestProvider |
string
Enum:
"NONE"
"AWS"
"AZURE"
"GCP"
Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster. |
|
Array of objects
(Component Label)
Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels. |
|
| mongoDBMajorVersion |
string
Default:
"4.4"
Enum:
"3.6"
"4.0"
"4.2"
"4.4"
"5.0"
Major MongoDB version of the cluster. MongoDB Cloud deploys the cluster with the latest stable release of the specified version. |
| mongoDBVersion |
string([\d]+\.[\d]+\.[\d]+)
Version of MongoDB that the cluster runs. |
| name |
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| numShards |
integer
<int32>
[ 1 .. 50 ]
Default:
1
Number of shards up to 50 to deploy for a sharded cluster. The
resource returns |
| paused |
boolean
Flag that indicates whether the cluster is paused. |
| pitEnabled |
boolean
Flag that indicates whether the cluster uses continuous cloud backups. |
| providerBackupEnabled |
boolean
Flag that indicates whether the M10 or higher cluster can perform
Cloud Backups. If set to |
|
object
(Cloud Service Provider Settings for a Cluster)
Group of cloud provider settings that configure the provisioned MongoDB hosts. |
|
| replicationFactor |
integer
<int32>
Deprecated
Default:
3
Enum:
3
5
7
Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use replicationSpecs instead. |
|
object
(Region Configuration)
Deprecated
Physical location where MongoDB Cloud provisions cluster nodes. |
|
|
Array of objects
(ApiAtlasLegacyReplicationSpecView)
List of settings that configure your cluster regions.
|
|
| rootCertType |
string
Default:
"ISRGROOTX1"
Value:
"ISRGROOTX1"
Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group. |
| terminationProtectionEnabled |
boolean
Default:
false
Flag that indicates whether termination protection is enabled on the
cluster. If set to |
| versionReleaseSystem |
string
Default:
"LTS"
Enum:
"LTS"
"CONTINUOUS"
Method by which the cluster maintains the MongoDB versions. If value
is |
{
-
"autoScaling":
{
-
"compute":
{
-
"enabled": true,
-
"scaleDownEnabled": true
},
-
"diskGBEnabled": true
},
-
"backupEnabled":
true,
-
"biConnector":
{
-
"enabled":
true,
-
"readPreference":
"PRIMARY"
},
-
"clusterType":
"REPLICASET",
-
"diskSizeGB":
10,
-
"encryptionAtRestProvider": "NONE",
-
"labels":
[
-
{
-
"key":
"string",
-
"value":
"string"
}
],
-
"mongoDBMajorVersion": "3.6",
-
"mongoDBVersion":
"string",
-
"name":
"string",
-
"numShards":
1,
-
"paused":
true,
-
"pitEnabled":
true,
-
"providerBackupEnabled": true,
-
"providerSettings": {
-
"providerName": "string",
-
"autoScaling":
{
-
"compute":
{
-
"maxInstanceSize":
"M10",
-
"minInstanceSize":
"M10"
}
},
-
"diskIOPS":
0,
-
"encryptEBSVolume": true,
-
"instanceSizeName": "M10",
-
"regionName":
"US_GOV_WEST_1",
-
"volumeType":
"STANDARD"
},
-
"replicationFactor": 3,
-
"replicationSpec": {
-
"property1":
{
-
"analyticsNodes": 0,
-
"electableNodes": 0,
-
"priority": 7,
-
"readOnlyNodes": 0
},
-
"property2":
{
-
"analyticsNodes": 0,
-
"electableNodes": 0,
-
"priority": 7,
-
"readOnlyNodes": 0
}
},
-
"replicationSpecs": [
-
{
-
"id":
"6492cb3770e674ece4e89b41",
-
"numShards": 1,
-
"regionsConfig":
{
-
"property1":
{
-
"analyticsNodes":
0,
-
"electableNodes":
0,
-
"priority":
7,
-
"readOnlyNodes":
0
},
-
"property2":
{
-
"analyticsNodes":
0,
-
"electableNodes":
0,
-
"priority":
7,
-
"readOnlyNodes":
0
}
},
-
"zoneName":
"string"
}
],
-
"rootCertType":
"ISRGROOTX1",
-
"terminationProtectionEnabled": false,
-
"versionReleaseSystem": "LTS"
}
{
-
"autoScaling":
{
-
"compute":
{
-
"enabled": true,
-
"scaleDownEnabled": true
},
-
"diskGBEnabled": true
},
-
"backupEnabled":
true,
-
"biConnector":
{
-
"enabled":
true,
-
"readPreference":
"PRIMARY"
},
-
"clusterType":
"REPLICASET",
-
"connectionStrings": {
-
"awsPrivateLink":
{
-
"property1":
"string",
-
"property2":
"string"
},
-
"awsPrivateLinkSrv":
{
-
"property1":
"string",
-
"property2":
"string"
},
-
"private":
"string",
-
"privateEndpoint":
[
-
{
-
"connectionString":
"string",
-
"endpoints":
[
-
{
-
"endpointId":
"string",
-
"providerName":
"AWS",
-
"region":
"string"
}
],
-
"srvConnectionString":
"string",
-
"type":
"MONGOD"
}
],
-
"privateSrv": "string",
-
"standard":
"string",
-
"standardSrv":
"string"
},
-
"createDate":
"2019-08-24T14:15:22Z",
-
"diskSizeGB":
10,
-
"encryptionAtRestProvider": "NONE",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"5faec72692cee15b51eb22a4",
-
"labels":
[
-
{
-
"key":
"string",
-
"value":
"string"
}
],
-
"links":
[
-
],
-
"mongoDBMajorVersion": "3.6",
-
"mongoDBVersion":
"string",
-
"mongoURI":
"string",
-
"mongoURIUpdated":
"2019-08-24T14:15:22Z",
-
"mongoURIWithOptions": "string",
-
"name":
"string",
-
"numShards":
1,
-
"paused":
true,
-
"pitEnabled":
true,
-
"providerBackupEnabled": true,
-
"providerSettings": {
-
"providerName": "string",
-
"autoScaling":
{
-
"compute":
{
-
"maxInstanceSize":
"M10",
-
"minInstanceSize":
"M10"
}
},
-
"diskIOPS":
0,
-
"encryptEBSVolume": true,
-
"instanceSizeName": "M10",
-
"regionName":
"US_GOV_WEST_1",
-
"volumeType":
"STANDARD"
},
-
"replicationFactor": 3,
-
"replicationSpec": {
-
"property1":
{
-
"analyticsNodes": 0,
-
"electableNodes": 0,
-
"priority": 7,
-
"readOnlyNodes": 0
},
-
"property2":
{
-
"analyticsNodes": 0,
-
"electableNodes": 0,
-
"priority": 7,
-
"readOnlyNodes": 0
}
},
-
"replicationSpecs": [
-
{
-
"id":
"6492cb3770e674ece4e89b41",
-
"numShards": 1,
-
"regionsConfig":
{
-
"property1":
{
-
"analyticsNodes":
0,
-
"electableNodes":
0,
-
"priority":
7,
-
"readOnlyNodes":
0
},
-
"property2":
{
-
"analyticsNodes":
0,
-
"electableNodes":
0,
-
"priority":
7,
-
"readOnlyNodes":
0
}
},
-
"zoneName":
"string"
}
],
-
"rootCertType":
"ISRGROOTX1",
-
"srvAddress":
"string",
-
"stateName":
"IDLE",
-
"terminationProtectionEnabled": false,
-
"versionReleaseSystem": "LTS"
}
Upgrades a shared-tier cluster to a serverless instance in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. This resource doesn't require the API key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Details of the shared-tier cluster upgrade in the specified project.
|
required
|
object
(Cloud Service Provider Settings for a Serverless Instance)
Group of cloud provider settings that configure the provisioned MongoDB serverless instance. |
|
object
(Serverless Backup Options)
Group of settings that configure serverless backup. |
|
| terminationProtectionEnabled |
boolean
Default:
false
Flag that indicates whether termination protection is enabled on the
serverless instance. If set to |
{
-
"providerSettings": {
-
"backingProviderName": "AWS",
-
"providerName":
"SERVERLESS",
-
"regionName":
"string"
},
-
"serverlessBackupOptions": {
-
"serverlessContinuousBackupEnabled": true
},
-
"terminationProtectionEnabled": false
}
{
-
"connectionStrings": {
-
"privateEndpoint":
[
-
{
-
"endpoints":
[
-
{
-
"endpointId":
"string",
-
"providerName":
"AWS",
-
"region":
"string"
}
],
-
"srvConnectionString":
"string",
-
"type":
"MONGOS"
}
],
-
"standardSrv":
"string"
},
-
"createDate":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"5faec72692cee15b51eb22a4",
-
"links":
[
-
],
-
"mongoDBVersion":
"string",
-
"name":
"string",
-
"providerSettings": {
-
"backingProviderName": "AWS",
-
"providerName":
"SERVERLESS",
-
"regionName":
"string"
},
-
"serverlessBackupOptions": {
-
"serverlessContinuousBackupEnabled": true
},
-
"stateName":
"IDLE",
-
"terminationProtectionEnabled": false
}
Returns the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings.
Shared-tier clusters can't use this resource.
To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"defaultReadConcern": "local",
-
"defaultWriteConcern": "1",
-
"failIndexKeyTooLong": true,
-
"javascriptEnabled": true,
-
"minimumEnabledTlsProtocol": "TLS1_0",
-
"noTableScan":
false,
-
"oplogMinRetentionHours": 0,
-
"oplogSizeMB":
0,
-
"sampleRefreshIntervalBIConnector": 0,
-
"sampleSizeBIConnector": 1000
}
Updates the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. To use this resource, the requesting API Key must have the Project Cluster Manager role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Advanced configuration details to add for one cluster in the specified project.
| defaultReadConcern |
string
Default:
"available"
Enum:
"local"
"available"
"majority"
"linearizable"
"snapshot"
Default level of acknowledgment requested from MongoDB for read operations set for this cluster.
MongoDB 4.4 clusters default to |
| defaultWriteConcern |
string
Default:
"1"
Default level of acknowledgment requested from MongoDB for write operations set for this cluster.
MongoDB 4.4 clusters default to |
| failIndexKeyTooLong |
boolean
Default:
true
Flag that indicates whether you can insert or update documents where all indexed entries don't exceed 1024 bytes. If you set this to false, mongod writes documents that exceed this limit but doesn't index them. |
| javascriptEnabled |
boolean
Default:
true
Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript. |
| minimumEnabledTlsProtocol |
string
Enum:
"TLS1_0"
"TLS1_1"
"TLS1_2"
Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version. |
| noTableScan |
boolean
Default:
false
Flag that indicates whether the cluster disables executing any query that requires a collection scan to return results. |
| oplogMinRetentionHours |
number or null
<double>
Minimum retention window for cluster's oplog expressed in hours. A value of null indicates that the cluster uses the default minimum oplog window that MongoDB Cloud calculates. |
| oplogSizeMB |
integer or null
<int32>
Storage limit of cluster's oplog expressed in megabytes. A value of null indicates that the cluster uses the default oplog size that MongoDB Cloud calculates. |
| sampleRefreshIntervalBIConnector |
integer
<int32>
>= 0
Default:
0
Interval in seconds at which the mongosqld process re-samples data to create its relational schema. |
| sampleSizeBIConnector |
integer
<int32>
>= 0
Default:
1000
Number of documents per database to sample when gathering schema information. |
{
-
"defaultReadConcern": "local",
-
"defaultWriteConcern": "1",
-
"failIndexKeyTooLong": true,
-
"javascriptEnabled": true,
-
"minimumEnabledTlsProtocol": "TLS1_0",
-
"noTableScan":
false,
-
"oplogMinRetentionHours": 0,
-
"oplogSizeMB":
0,
-
"sampleRefreshIntervalBIConnector": 0,
-
"sampleSizeBIConnector": 1000
}
{
-
"defaultReadConcern": "local",
-
"defaultWriteConcern": "1",
-
"failIndexKeyTooLong": true,
-
"javascriptEnabled": true,
-
"minimumEnabledTlsProtocol": "TLS1_0",
-
"noTableScan":
false,
-
"oplogMinRetentionHours": 0,
-
"oplogSizeMB":
0,
-
"sampleRefreshIntervalBIConnector": 0,
-
"sampleSizeBIConnector": 1000
}
Starts a failover test for the specified cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster's primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. To use this resource, the requesting API Key must have the Project Cluster Manager role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint)",
-
"error":
401,
-
"errorCode":
"NOT_ORG_GROUP_CREATOR",
-
"parameters":
[
-
"EXAMPLE"
],
-
"reason":
"Unauthorized"
}
Returns the status of all changes that you made to the specified cluster in the specified project. Use this resource to check the progress MongoDB Cloud has made in processing your changes. The response does not include the deployment of new dedicated clusters. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"changeStatus":
"PENDING",
-
"links":
[
-
]
}
Removes one cluster in the specific project. Clusters contain a group of hosts that maintain the same data set. The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
name
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response does not include multi-cloud clusters. To return a multi-cloud cluster, use Get One Advanced Cluster. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
name
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"autoScaling":
{
-
"compute":
{
-
"enabled": true,
-
"scaleDownEnabled": true
},
-
"diskGBEnabled": true
},
-
"backupEnabled":
true,
-
"biConnector":
{
-
"enabled":
true,
-
"readPreference":
"PRIMARY"
},
-
"clusterType":
"REPLICASET",
-
"connectionStrings": {
-
"awsPrivateLink":
{
-
"property1":
"string",
-
"property2":
"string"
},
-
"awsPrivateLinkSrv":
{
-
"property1":
"string",
-
"property2":
"string"
},
-
"private":
"string",
-
"privateEndpoint":
[
-
{
-
"connectionString":
"string",
-
"endpoints":
[
-
{
-
"endpointId":
"string",
-
"providerName":
"AWS",
-
"region":
"string"
}
],
-
"srvConnectionString":
"string",
-
"type":
"MONGOD"
}
],
-
"privateSrv": "string",
-
"standard":
"string",
-
"standardSrv":
"string"
},
-
"createDate":
"2019-08-24T14:15:22Z",
-
"diskSizeGB":
10,
-
"encryptionAtRestProvider": "NONE",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"5faec72692cee15b51eb22a4",
-
"labels":
[
-
{
-
"key":
"string",
-
"value":
"string"
}
],
-
"links":
[
-
],
-
"mongoDBMajorVersion": "3.6",
-
"mongoDBVersion":
"string",
-
"mongoURI":
"string",
-
"mongoURIUpdated":
"2019-08-24T14:15:22Z",
-
"mongoURIWithOptions": "string",
-
"name":
"string",
-
"numShards":
1,
-
"paused":
true,
-
"pitEnabled":
true,
-
"providerBackupEnabled": true,
-
"providerSettings": {
-
"providerName": "string",
-
"autoScaling":
{
-
"compute":
{
-
"maxInstanceSize":
"M10",
-
"minInstanceSize":
"M10"
}
},
-
"diskIOPS":
0,
-
"encryptEBSVolume": true,
-
"instanceSizeName": "M10",
-
"regionName":
"US_GOV_WEST_1",
-
"volumeType":
"STANDARD"
},
-
"replicationFactor": 3,
-
"replicationSpec": {
-
"property1":
{
-
"analyticsNodes": 0,
-
"electableNodes": 0,
-
"priority": 7,
-
"readOnlyNodes": 0
},
-
"property2":
{
-
"analyticsNodes": 0,
-
"electableNodes": 0,
-
"priority": 7,
-
"readOnlyNodes": 0
}
},
-
"replicationSpecs": [
-
{
-
"id":
"6492cb3770e674ece4e89b41",
-
"numShards": 1,
-
"regionsConfig":
{
-
"property1":
{
-
"analyticsNodes":
0,
-
"electableNodes":
0,
-
"priority":
7,
-
"readOnlyNodes":
0
},
-
"property2":
{
-
"analyticsNodes":
0,
-
"electableNodes":
0,
-
"priority":
7,
-
"readOnlyNodes":
0
}
},
-
"zoneName":
"string"
}
],
-
"rootCertType":
"ISRGROOTX1",
-
"srvAddress":
"string",
-
"stateName":
"IDLE",
-
"terminationProtectionEnabled": false,
-
"versionReleaseSystem": "LTS"
}
Update the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource does not update multi-cloud clusters. To update a multi-cloud cluster, use Update One Advanced Cluster. To update a cluster's termination protection, the requesting API Key must have the Project Owner role. For all other updates, the requesting API Key must have the Project Cluster Manager role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
name
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Details to update for one cluster in the specified project.
|
object
(Automatic Cluster Scaling Settings)
Range of instance sizes to which your cluster can scale. |
|
| backupEnabled |
boolean
Flag that indicates whether the cluster can perform backups. If set
to |
|
object
(MongoDB Connector for Business Intelligence Settings)
Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster. |
|
| clusterType |
string
Enum:
"REPLICASET"
"SHARDED"
"GEOSHARDED"
Configuration of nodes that comprise the cluster. |
| diskSizeGB |
number
<double>
[ 10 .. 4096 ]
Storage capacity that the host's root volume possesses expressed in gigabytes. Increase this number to add capacity. MongoDB Cloud requires this parameter if you set replicationSpecs. If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. |
| encryptionAtRestProvider |
string
Enum:
"NONE"
"AWS"
"AZURE"
"GCP"
Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster. |
|
Array of objects
(Component Label)
Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels. |
|
| mongoDBMajorVersion |
string
Default:
"4.4"
Enum:
"3.6"
"4.0"
"4.2"
"4.4"
"5.0"
Major MongoDB version of the cluster. MongoDB Cloud deploys the cluster with the latest stable release of the specified version. |
| mongoDBVersion |
string([\d]+\.[\d]+\.[\d]+)
Version of MongoDB that the cluster runs. |
| name |
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| numShards |
integer
<int32>
[ 1 .. 50 ]
Default:
1
Number of shards up to 50 to deploy for a sharded cluster. The
resource returns |
| paused |
boolean
Flag that indicates whether the cluster is paused. |
| pitEnabled |
boolean
Flag that indicates whether the cluster uses continuous cloud backups. |
| providerBackupEnabled |
boolean
Flag that indicates whether the M10 or higher cluster can perform
Cloud Backups. If set to |
|
object
(Cloud Service Provider Settings for a Cluster)
Group of cloud provider settings that configure the provisioned MongoDB hosts. |
|
| replicationFactor |
integer
<int32>
Deprecated
Default:
3
Enum:
3
5
7
Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use replicationSpecs instead. |
|
object
(Region Configuration)
Deprecated
Physical location where MongoDB Cloud provisions cluster nodes. |
|
|
Array of objects
(ApiAtlasLegacyReplicationSpecView)
List of settings that configure your cluster regions.
|
|
| rootCertType |
string
Default:
"ISRGROOTX1"
Value:
"ISRGROOTX1"
Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group. |
| terminationProtectionEnabled |
boolean
Default:
false
Flag that indicates whether termination protection is enabled on the
cluster. If set to |
| versionReleaseSystem |
string
Default:
"LTS"
Enum:
"LTS"
"CONTINUOUS"
Method by which the cluster maintains the MongoDB versions. If value
is |
{
-
"autoScaling":
{
-
"compute":
{
-
"enabled": true,
-
"scaleDownEnabled": true
},
-
"diskGBEnabled": true
},
-
"backupEnabled":
true,
-
"biConnector":
{
-
"enabled":
true,
-
"readPreference":
"PRIMARY"
},
-
"clusterType":
"REPLICASET",
-
"diskSizeGB":
10,
-
"encryptionAtRestProvider": "NONE",
-
"labels":
[
-
{
-
"key":
"string",
-
"value":
"string"
}
],
-
"mongoDBMajorVersion": "3.6",
-
"mongoDBVersion":
"string",
-
"name":
"string",
-
"numShards":
1,
-
"paused":
true,
-
"pitEnabled":
true,
-
"providerBackupEnabled": true,
-
"providerSettings": {
-
"providerName": "string",
-
"autoScaling":
{
-
"compute":
{
-
"maxInstanceSize":
"M10",
-
"minInstanceSize":
"M10"
}
},
-
"diskIOPS":
0,
-
"encryptEBSVolume": true,
-
"instanceSizeName": "M10",
-
"regionName":
"US_GOV_WEST_1",
-
"volumeType":
"STANDARD"
},
-
"replicationFactor": 3,
-
"replicationSpec": {
-
"property1":
{
-
"analyticsNodes": 0,
-
"electableNodes": 0,
-
"priority": 7,
-
"readOnlyNodes": 0
},
-
"property2":
{
-
"analyticsNodes": 0,
-
"electableNodes": 0,
-
"priority": 7,
-
"readOnlyNodes": 0
}
},
-
"replicationSpecs": [
-
{
-
"id":
"6492cb3770e674ece4e89b41",
-
"numShards": 1,
-
"regionsConfig":
{
-
"property1":
{
-
"analyticsNodes":
0,
-
"electableNodes":
0,
-
"priority":
7,
-
"readOnlyNodes":
0
},
-
"property2":
{
-
"analyticsNodes":
0,
-
"electableNodes":
0,
-
"priority":
7,
-
"readOnlyNodes":
0
}
},
-
"zoneName":
"string"
}
],
-
"rootCertType":
"ISRGROOTX1",
-
"terminationProtectionEnabled": false,
-
"versionReleaseSystem": "LTS"
}
{
-
"autoScaling":
{
-
"compute":
{
-
"enabled": true,
-
"scaleDownEnabled": true
},
-
"diskGBEnabled": true
},
-
"backupEnabled":
true,
-
"biConnector":
{
-
"enabled":
true,
-
"readPreference":
"PRIMARY"
},
-
"clusterType":
"REPLICASET",
-
"connectionStrings": {
-
"awsPrivateLink":
{
-
"property1":
"string",
-
"property2":
"string"
},
-
"awsPrivateLinkSrv":
{
-
"property1":
"string",
-
"property2":
"string"
},
-
"private":
"string",
-
"privateEndpoint":
[
-
{
-
"connectionString":
"string",
-
"endpoints":
[
-
{
-
"endpointId":
"string",
-
"providerName":
"AWS",
-
"region":
"string"
}
],
-
"srvConnectionString":
"string",
-
"type":
"MONGOD"
}
],
-
"privateSrv": "string",
-
"standard":
"string",
-
"standardSrv":
"string"
},
-
"createDate":
"2019-08-24T14:15:22Z",
-
"diskSizeGB":
10,
-
"encryptionAtRestProvider": "NONE",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"5faec72692cee15b51eb22a4",
-
"labels":
[
-
{
-
"key":
"string",
-
"value":
"string"
}
],
-
"links":
[
-
],
-
"mongoDBMajorVersion": "3.6",
-
"mongoDBVersion":
"string",
-
"mongoURI":
"string",
-
"mongoURIUpdated":
"2019-08-24T14:15:22Z",
-
"mongoURIWithOptions": "string",
-
"name":
"string",
-
"numShards":
1,
-
"paused":
true,
-
"pitEnabled":
true,
-
"providerBackupEnabled": true,
-
"providerSettings": {
-
"providerName": "string",
-
"autoScaling":
{
-
"compute":
{
-
"maxInstanceSize":
"M10",
-
"minInstanceSize":
"M10"
}
},
-
"diskIOPS":
0,
-
"encryptEBSVolume": true,
-
"instanceSizeName": "M10",
-
"regionName":
"US_GOV_WEST_1",
-
"volumeType":
"STANDARD"
},
-
"replicationFactor": 3,
-
"replicationSpec": {
-
"property1":
{
-
"analyticsNodes": 0,
-
"electableNodes": 0,
-
"priority": 7,
-
"readOnlyNodes": 0
},
-
"property2":
{
-
"analyticsNodes": 0,
-
"electableNodes": 0,
-
"priority": 7,
-
"readOnlyNodes": 0
}
},
-
"replicationSpecs": [
-
{
-
"id":
"6492cb3770e674ece4e89b41",
-
"numShards": 1,
-
"regionsConfig":
{
-
"property1":
{
-
"analyticsNodes":
0,
-
"electableNodes":
0,
-
"priority":
7,
-
"readOnlyNodes":
0
},
-
"property2":
{
-
"analyticsNodes":
0,
-
"electableNodes":
0,
-
"priority":
7,
-
"readOnlyNodes":
0
}
},
-
"zoneName":
"string"
}
],
-
"rootCertType":
"ISRGROOTX1",
-
"srvAddress":
"string",
-
"stateName":
"IDLE",
-
"terminationProtectionEnabled": false,
-
"versionReleaseSystem": "LTS"
}
Requests loading the MongoDB sample dataset into the specified cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
name
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster into which you load the sample dataset. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
Cluster into which to load the sample dataset.
{ }
[
-
{
-
"_id":
"4c0971b71b6b7c6e2020b535",
-
"clusterName": "string",
-
"completeDate":
"2019-08-24T14:15:22Z",
-
"createDate":
"2019-08-24T14:15:22Z",
-
"errorMessage": "string",
-
"state":
"WORKING"
}
]
Checks the progress of loading the sample dataset into one cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
sampleDatasetId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the loaded sample dataset. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"_id":
"4c0971b71b6b7c6e2020b535",
-
"clusterName":
"string",
-
"completeDate":
"2019-08-24T14:15:22Z",
-
"createDate":
"2019-08-24T14:15:22Z",
-
"errorMessage":
"string",
-
"state":
"WORKING"
}
Returns the custom DNS configuration for AWS clusters in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"enabled":
true
}
Enables or disables the custom DNS configuration for AWS clusters in the specified project. Enable custom DNS if you use AWS VPC peering and use your own DNS servers. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Enables or disables the custom DNS configuration for AWS clusters in the specified project.
|
enabled
required
|
boolean
Flag that indicates whether the project's clusters deployed to
Amazon Web Services (AWS) use a custom Domain Name System (DNS).
When |
{
-
"enabled":
true
}
{
-
"enabled":
true
}
Returns all custom roles for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
[
-
{
-
"actions":
[
-
{
-
"action":
"FIND",
-
"resources":
[
-
{
-
"cluster":
true,
-
"collection":
"string",
-
"db":
"string"
}
]
}
],
-
"inheritedRoles":
[
-
{
-
"db":
"string",
-
"role":
"string"
}
],
-
"roleName":
"string"
}
]
Creates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Creates one custom role in the specified project.
|
Array of objects
(Database Privilege Action)
List of the individual privilege actions that the role grants. |
|
|
Array of objects
(Inherited Role)
unique
List of the built-in roles that this custom role inherits. |
|
|
roleName
required
|
string^\b(?!xgen-)([0-9A-Za-z_\-]+)\b(?<!\atlasAdmi...
Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project. |
{
-
"actions":
[
-
{
-
"action":
"FIND",
-
"resources":
[
-
{
-
"cluster":
true,
-
"collection":
"string",
-
"db":
"string"
}
]
}
],
-
"inheritedRoles":
[
-
{
-
"db":
"string",
-
"role":
"string"
}
],
-
"roleName":
"string"
}
{
-
"actions":
[
-
{
-
"action":
"FIND",
-
"resources":
[
-
{
-
"cluster":
true,
-
"collection":
"string",
-
"db":
"string"
}
]
}
],
-
"inheritedRoles":
[
-
{
-
"db":
"string",
-
"role":
"string"
}
],
-
"roleName":
"string"
}
Removes one custom role from the specified project. You can't remove a custom role that would leave one or more child roles with no parent roles or actions. You also can't remove a custom role that would leave one or more database users without roles. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
roleName
required
|
string^\b(?!xgen-)([0-9A-Za-z_\-]+)\b(?<!\atlasAdmi...
Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns one custom role for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
roleName
required
|
string^\b(?!xgen-)([0-9A-Za-z_\-]+)\b(?<!\atlasAdmi...
Human-readable label that identifies the role for the request. This name must be unique for this custom role in this project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"actions":
[
-
{
-
"action":
"FIND",
-
"resources":
[
-
{
-
"cluster":
true,
-
"collection":
"string",
-
"db":
"string"
}
]
}
],
-
"inheritedRoles":
[
-
{
-
"db":
"string",
-
"role":
"string"
}
],
-
"roleName":
"string"
}
Updates one custom role in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
roleName
required
|
string^\b(?!xgen-)([0-9A-Za-z_\-]+)\b(?<!\atlasAdmi...
Human-readable label that identifies the role for the request. This name must beunique for this custom role in this project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Updates one custom role in the specified project.
|
Array of objects
(Database Privilege Action)
List of the individual privilege actions that the role grants. |
|
|
Array of objects
(Inherited Role)
unique
List of the built-in roles that this custom role inherits. |
{
-
"actions":
[
-
{
-
"action":
"FIND",
-
"resources":
[
-
{
-
"cluster":
true,
-
"collection":
"string",
-
"db":
"string"
}
]
}
],
-
"inheritedRoles":
[
-
{
-
"db":
"string",
-
"role":
"string"
}
]
}
{
-
"actions":
[
-
{
-
"action":
"FIND",
-
"resources":
[
-
{
-
"cluster":
true,
-
"collection":
"string",
-
"db":
"string"
}
]
}
],
-
"inheritedRoles":
[
-
{
-
"db":
"string",
-
"role":
"string"
}
],
-
"roleName":
"string"
}
Returns all database users that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"awsIAMType":
"NONE",
-
"databaseName":
"admin",
-
"deleteAfterDate":
"2019-08-24T14:15:22Z",
-
"labels":
[
-
{
-
"key":
"string",
-
"value":
"string"
}
],
-
"ldapAuthType":
"NONE",
-
"links":
[
-
],
-
"roles":
[
-
{
-
"collectionName":
"string",
-
"databaseName":
"string",
-
"roleName":
"atlasAdmin"
}
],
-
"scopes":
[
-
{
-
"name":
"string",
-
"type":
"CLUSTER"
}
],
-
"username":
"string",
-
"x509Type":
"NONE"
}
],
-
"totalCount":
0
}
Creates one database user in the specified project. This MongoDB Cloud supports a maximum of 100 database users per project. If you require more than 100 database users on a project, contact Support. To use this resource, the requesting API Key must have the Project Atlas Admin or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Creates one database user in the specified project.
| awsIAMType |
string
Default:
"NONE"
Enum:
"NONE"
"USER"
"ROLE"
Human-readable label that indicates whether the new database user authenticates with the Amazon Web Services (AWS) Identity and Access Management (IAM) credentials associated with the user or the user's role. |
||||||||||||||||||||||||||||||||
|
databaseName
required
|
string
Default:
"admin"
Enum:
"admin"
"$external"
Database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. |
||||||||||||||||||||||||||||||||
| deleteAfterDate |
string
<date-time>
Date and time when MongoDB Cloud deletes the user. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. You must specify a future date that falls within one week of making the Application Programming Interface (API) request. |
||||||||||||||||||||||||||||||||
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the project. |
||||||||||||||||||||||||||||||||
|
Array of objects
(Component Label)
List that contains the key-value pairs for tagging and categorizing the MongoDB database user. The labels that you define do not appear in the console. |
|||||||||||||||||||||||||||||||||
| ldapAuthType |
string
Default:
"NONE"
Enum:
"NONE"
"GROUP"
"USER"
Part of the Lightweight Directory Access Protocol (LDAP) record that the database uses to authenticate this database user on the LDAP host. |
||||||||||||||||||||||||||||||||
| password |
string
>= 8 characters
Alphanumeric string that authenticates this database user against
the database specified in |
||||||||||||||||||||||||||||||||
|
Array of objects
(Database User Role)
List that provides the pairings of one role with one applicable database. |
|||||||||||||||||||||||||||||||||
|
Array of objects
(Database User Scope)
List that contains clusters and MongoDB Atlas Data Lakes that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters and MongoDB Atlas Data Lakes in the project. |
|||||||||||||||||||||||||||||||||
|
username
required
|
string
<= 1024 characters
Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:
|
||||||||||||||||||||||||||||||||
| x509Type |
string
Default:
"NONE"
Enum:
"NONE"
"CUSTOMER"
"MANAGED"
X.509 method that MongoDB Cloud uses to authenticate the database user.
Users created with the |
AWS IAM Authentication
{
-
"databaseName":
"$external",
-
"awsIAMType":
"USER",
-
"roles":
[
-
{
-
"databaseName":
"sales",
-
"roleName":
"readWrite"
},
-
{
-
"databaseName":
"marketing",
-
"roleName":
"read"
}
],
-
"scopes":
[
-
{
-
"name":
"myCluster",
-
"type":
"CLUSTER"
}
],
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"username":
"arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user"
}
{
-
"awsIAMType":
"NONE",
-
"databaseName":
"admin",
-
"deleteAfterDate":
"2019-08-24T14:15:22Z",
-
"labels":
[
-
{
-
"key":
"string",
-
"value":
"string"
}
],
-
"ldapAuthType":
"NONE",
-
"links":
[
-
],
-
"roles":
[
-
{
-
"collectionName":
"string",
-
"databaseName":
"string",
-
"roleName":
"atlasAdmin"
}
],
-
"scopes":
[
-
{
-
"name":
"string",
-
"type":
"CLUSTER"
}
],
-
"username":
"string",
-
"x509Type":
"NONE"
}
Removes one database user from the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
||||||||||||||||||||||||||||||||
|
databaseName
required
|
string
Human-readable label that identifies the database against which
the database user authenticates. Database users must provide both
a username and authentication database to log into MongoDB. If the
user authenticates with AWS IAM, x.509, or LDAP, this value should
be |
||||||||||||||||||||||||||||||||
|
username
required
|
string
Example:
SCRAM-SHA: dylan or AWS IAM:
arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs orx.509
or LDAP: CN=Dylan
Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM
Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:
|
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint)",
-
"error":
401,
-
"errorCode":
"NOT_ORG_GROUP_CREATOR",
-
"parameters":
[
-
"EXAMPLE"
],
-
"reason":
"Unauthorized"
}
Returns one database user that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
||||||||||||||||||||||||||||||||
|
databaseName
required
|
string
Human-readable label that identifies the database against which
the database user authenticates. Database users must provide both
a username and authentication database to log into MongoDB. If the
user authenticates with AWS IAM, x.509, or LDAP, this value should
be |
||||||||||||||||||||||||||||||||
|
username
required
|
string
Example:
SCRAM-SHA: dylan or AWS IAM:
arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs orx.509
or LDAP: CN=Dylan
Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM
Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:
|
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"awsIAMType":
"NONE",
-
"databaseName":
"admin",
-
"deleteAfterDate":
"2019-08-24T14:15:22Z",
-
"labels":
[
-
{
-
"key":
"string",
-
"value":
"string"
}
],
-
"ldapAuthType":
"NONE",
-
"links":
[
-
],
-
"roles":
[
-
{
-
"collectionName":
"string",
-
"databaseName":
"string",
-
"roleName":
"atlasAdmin"
}
],
-
"scopes":
[
-
{
-
"name":
"string",
-
"type":
"CLUSTER"
}
],
-
"username":
"string",
-
"x509Type":
"NONE"
}
Updates one database user that belongs to the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
||||||||||||||||||||||||||||||||
|
databaseName
required
|
string
Human-readable label that identifies the database against which
the database user authenticates. Database users must provide both
a username and authentication database to log into MongoDB. If the
user authenticates with AWS IAM, x.509, or LDAP, this value should
be |
||||||||||||||||||||||||||||||||
|
username
required
|
string
Example:
SCRAM-SHA: dylan or AWS IAM:
arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs orx.509
or LDAP: CN=Dylan
Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM
Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:
|
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Updates one database user that belongs to the specified project.
| awsIAMType |
string
Default:
"NONE"
Enum:
"NONE"
"USER"
"ROLE"
Human-readable label that indicates whether the new database user authenticates with the Amazon Web Services (AWS) Identity and Access Management (IAM) credentials associated with the user or the user's role. |
||||||||||||||||||||||||||||||||
|
databaseName
required
|
string
Default:
"admin"
Enum:
"admin"
"$external"
Database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. |
||||||||||||||||||||||||||||||||
| deleteAfterDate |
string
<date-time>
Date and time when MongoDB Cloud deletes the user. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. You must specify a future date that falls within one week of making the Application Programming Interface (API) request. |
||||||||||||||||||||||||||||||||
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the project. |
||||||||||||||||||||||||||||||||
|
Array of objects
(Component Label)
List that contains the key-value pairs for tagging and categorizing the MongoDB database user. The labels that you define do not appear in the console. |
|||||||||||||||||||||||||||||||||
| ldapAuthType |
string
Default:
"NONE"
Enum:
"NONE"
"GROUP"
"USER"
Part of the Lightweight Directory Access Protocol (LDAP) record that the database uses to authenticate this database user on the LDAP host. |
||||||||||||||||||||||||||||||||
| password |
string
>= 8 characters
Alphanumeric string that authenticates this database user against
the database specified in |
||||||||||||||||||||||||||||||||
|
Array of objects
(Database User Role)
List that provides the pairings of one role with one applicable database. |
|||||||||||||||||||||||||||||||||
|
Array of objects
(Database User Scope)
List that contains clusters and MongoDB Atlas Data Lakes that this database user can access. If omitted, MongoDB Cloud grants the database user access to all the clusters and MongoDB Atlas Data Lakes in the project. |
|||||||||||||||||||||||||||||||||
|
username
required
|
string
<= 1024 characters
Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:
|
||||||||||||||||||||||||||||||||
| x509Type |
string
Default:
"NONE"
Enum:
"NONE"
"CUSTOMER"
"MANAGED"
X.509 method that MongoDB Cloud uses to authenticate the database user.
Users created with the |
{
-
"awsIAMType":
"NONE",
-
"databaseName":
"admin",
-
"deleteAfterDate":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"labels":
[
-
{
-
"key":
"string",
-
"value":
"string"
}
],
-
"ldapAuthType":
"NONE",
-
"password":
"stringst",
-
"roles":
[
-
{
-
"collectionName":
"string",
-
"databaseName":
"string",
-
"roleName":
"atlasAdmin"
}
],
-
"scopes":
[
-
{
-
"name":
"string",
-
"type":
"CLUSTER"
}
],
-
"username":
"string",
-
"x509Type":
"NONE"
}
{
-
"awsIAMType":
"NONE",
-
"databaseName":
"admin",
-
"deleteAfterDate":
"2019-08-24T14:15:22Z",
-
"labels":
[
-
{
-
"key":
"string",
-
"value":
"string"
}
],
-
"ldapAuthType":
"NONE",
-
"links":
[
-
],
-
"roles":
[
-
{
-
"collectionName":
"string",
-
"databaseName":
"string",
-
"roleName":
"atlasAdmin"
}
],
-
"scopes":
[
-
{
-
"name":
"string",
-
"type":
"CLUSTER"
}
],
-
"username":
"string",
-
"x509Type":
"NONE"
}
Returns, adds, edits, and removes Federated Database Instances and private endpoints.
Returns the details of all federated database instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only or higher role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| type |
string
Default:
"USER"
Enum:
"USER"
"ONLINE_ARCHIVE"
Type of Federated Database Instances to return. |
[
-
{
-
"cloudProviderConfig":
{
-
"aws":
{
-
"externalId":
"string",
-
"iamAssumedRoleARN":
"arn:aws:iam::123456789012:root",
-
"iamUserARN":
"string",
-
"roleId":
"string"
}
},
-
"dataProcessRegion":
{
-
"cloudProvider":
"AWS",
-
"region":
"SYDNEY_AUS"
},
-
"name":
"string",
-
"storage":
{
-
"databases":
[
-
{
-
"collections":
[
-
{
-
"dataSources":
[
-
{
-
"allowInsecure":
false,
-
"collection":
"string",
-
"collectionRegex":
"string",
-
"database":
"string",
-
"databaseRegex":
"string",
-
"defaultFormat":
".avro",
-
"path":
"string",
-
"provenanceFieldName":
"string",
-
"storeName":
"string",
-
"urls":
[
-
null
]
}
],
-
"name":
"string"
}
],
-
"maxWildcardCollections":
100,
-
"name":
"string",
-
"views":
[
-
{
-
"name":
"string",
-
"pipeline":
"string",
-
"source":
"string"
}
]
}
],
-
"stores":
[
-
{
-
"name":
"string",
-
"provider":
"string",
-
"additionalStorageClasses":
[
-
"STANDARD"
],
-
"bucket":
"string",
-
"delimiter":
"string",
-
"includeTags":
false,
-
"prefix":
"string",
-
"public":
false,
-
"region":
"US_GOV_WEST_1"
}
]
}
}
]
Creates one federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Details to create one federated database instance in the specified project.
|
object
(Data Lake Cloud Provider)
Cloud provider linked to this data lake. |
|
|
object
(ApiAtlasDataLakeDataProcessRegionView)
Information about the cloud provider region to which the data lake routes client connections. MongoDB Cloud supports AWS only. |
|
| name |
string
Human-readable label that identifies the data lake. |
|
object
(ApiAtlasDataLakeStorageView)
Configuration information for each data store and its mapping to MongoDB Cloud databases. |
{
-
"cloudProviderConfig": {
-
"aws":
{
-
"roleId":
"string",
-
"testS3Bucket":
"string"
}
},
-
"dataProcessRegion": {
-
"cloudProvider": "AWS",
-
"region":
"SYDNEY_AUS"
},
-
"name":
"string",
-
"storage":
{
-
"databases":
[
-
{
-
"collections":
[
-
{
-
"dataSources":
[
-
{
-
"allowInsecure":
false,
-
"collection":
"string",
-
"collectionRegex":
"string",
-
"database":
"string",
-
"databaseRegex":
"string",
-
"defaultFormat":
".avro",
-
"path":
"string",
-
"provenanceFieldName":
"string",
-
"storeName":
"string",
-
"urls":
[
-
"string"
]
}
],
-
"name":
"string"
}
],
-
"maxWildcardCollections": 100,
-
"name":
"string",
-
"views":
[
-
{
-
"name":
"string",
-
"pipeline":
"string",
-
"source":
"string"
}
]
}
],
-
"stores":
[
-
{
-
"name":
"string",
-
"provider":
"string",
-
"additionalStorageClasses":
[
-
"STANDARD"
],
-
"bucket":
"string",
-
"delimiter":
"string",
-
"includeTags": false,
-
"prefix":
"string",
-
"public": false,
-
"region":
"US_GOV_WEST_1"
}
]
}
}
{
-
"cloudProviderConfig": {
-
"aws":
{
-
"externalId":
"string",
-
"iamAssumedRoleARN":
"arn:aws:iam::123456789012:root",
-
"iamUserARN":
"string",
-
"roleId":
"string"
}
},
-
"dataProcessRegion": {
-
"cloudProvider": "AWS",
-
"region":
"SYDNEY_AUS"
},
-
"name":
"string",
-
"storage":
{
-
"databases":
[
-
{
-
"collections":
[
-
{
-
"dataSources":
[
-
{
-
"allowInsecure":
false,
-
"collection":
"string",
-
"collectionRegex":
"string",
-
"database":
"string",
-
"databaseRegex":
"string",
-
"defaultFormat":
".avro",
-
"path":
"string",
-
"provenanceFieldName":
"string",
-
"storeName":
"string",
-
"urls":
[
-
"string"
]
}
],
-
"name":
"string"
}
],
-
"maxWildcardCollections": 100,
-
"name":
"string",
-
"views":
[
-
{
-
"name":
"string",
-
"pipeline":
"string",
-
"source":
"string"
}
]
}
],
-
"stores":
[
-
{
-
"name":
"string",
-
"provider":
"string",
-
"additionalStorageClasses":
[
-
"STANDARD"
],
-
"bucket":
"string",
-
"delimiter":
"string",
-
"includeTags": false,
-
"prefix":
"string",
-
"public": false,
-
"region":
"US_GOV_WEST_1"
}
]
}
}
Removes one federated database instance from the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
tenantName
required
|
string
Human-readable label that identifies the federated database instance to remove. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) Cannot find resource
AWS",
-
"error":
404,
-
"errorCode":
"RESOURCE_NOT_FOUND",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Not Found"
}
Returns the details of one federated database instance within the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
tenantName
required
|
string
Human-readable label that identifies the Federated Database to return. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"cloudProviderConfig": {
-
"aws":
{
-
"externalId":
"string",
-
"iamAssumedRoleARN":
"arn:aws:iam::123456789012:root",
-
"iamUserARN":
"string",
-
"roleId":
"string"
}
},
-
"dataProcessRegion": {
-
"cloudProvider": "AWS",
-
"region":
"SYDNEY_AUS"
},
-
"name":
"string",
-
"storage":
{
-
"databases":
[
-
{
-
"collections":
[
-
{
-
"dataSources":
[
-
{
-
"allowInsecure":
false,
-
"collection":
"string",
-
"collectionRegex":
"string",
-
"database":
"string",
-
"databaseRegex":
"string",
-
"defaultFormat":
".avro",
-
"path":
"string",
-
"provenanceFieldName":
"string",
-
"storeName":
"string",
-
"urls":
[
-
"string"
]
}
],
-
"name":
"string"
}
],
-
"maxWildcardCollections": 100,
-
"name":
"string",
-
"views":
[
-
{
-
"name":
"string",
-
"pipeline":
"string",
-
"source":
"string"
}
]
}
],
-
"stores":
[
-
{
-
"name":
"string",
-
"provider":
"string",
-
"additionalStorageClasses":
[
-
"STANDARD"
],
-
"bucket":
"string",
-
"delimiter":
"string",
-
"includeTags": false,
-
"prefix":
"string",
-
"public": false,
-
"region":
"US_GOV_WEST_1"
}
]
}
}
Updates the details of one federated database instance in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin or higher role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
tenantName
required
|
string
Human-readable label that identifies the federated database instance to update. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
|
skipRoleValidation
required
|
boolean
Flag that indicates whether this request should check if the requesting IAM role can read from the S3 bucket. AWS checks if the role can list the objects in the bucket before writing to it. Some IAM roles only need write permissions. This flag allows you to skip that check. |
Details of one Federated Database to update in the specified project.
|
object
(Data Lake Cloud Provider)
Cloud provider linked to this data lake. |
|
|
object
(ApiAtlasDataLakeDataProcessRegionView)
Information about the cloud provider region to which the data lake routes client connections. MongoDB Cloud supports AWS only. |
|
| name |
string
Human-readable label that identifies the data lake. |
|
object
(ApiAtlasDataLakeStorageView)
Configuration information for each data store and its mapping to MongoDB Cloud databases. |
{
-
"cloudProviderConfig": {
-
"aws":
{
-
"roleId":
"string",
-
"testS3Bucket":
"string"
}
},
-
"dataProcessRegion": {
-
"cloudProvider": "AWS",
-
"region":
"SYDNEY_AUS"
},
-
"name":
"string",
-
"storage":
{
-
"databases":
[
-
{
-
"collections":
[
-
{
-
"dataSources":
[
-
{
-
"allowInsecure":
false,
-
"collection":
"string",
-
"collectionRegex":
"string",
-
"database":
"string",
-
"databaseRegex":
"string",
-
"defaultFormat":
".avro",
-
"path":
"string",
-
"provenanceFieldName":
"string",
-
"storeName":
"string",
-
"urls":
[
-
"string"
]
}
],
-
"name":
"string"
}
],
-
"maxWildcardCollections": 100,
-
"name":
"string",
-
"views":
[
-
{
-
"name":
"string",
-
"pipeline":
"string",
-
"source":
"string"
}
]
}
],
-
"stores":
[
-
{
-
"name":
"string",
-
"provider":
"string",
-
"additionalStorageClasses":
[
-
"STANDARD"
],
-
"bucket":
"string",
-
"delimiter":
"string",
-
"includeTags": false,
-
"prefix":
"string",
-
"public": false,
-
"region":
"US_GOV_WEST_1"
}
]
}
}
{
-
"cloudProviderConfig": {
-
"aws":
{
-
"externalId":
"string",
-
"iamAssumedRoleARN":
"arn:aws:iam::123456789012:root",
-
"iamUserARN":
"string",
-
"roleId":
"string"
}
},
-
"dataProcessRegion": {
-
"cloudProvider": "AWS",
-
"region":
"SYDNEY_AUS"
},
-
"name":
"string",
-
"storage":
{
-
"databases":
[
-
{
-
"collections":
[
-
{
-
"dataSources":
[
-
{
-
"allowInsecure":
false,
-
"collection":
"string",
-
"collectionRegex":
"string",
-
"database":
"string",
-
"databaseRegex":
"string",
-
"defaultFormat":
".avro",
-
"path":
"string",
-
"provenanceFieldName":
"string",
-
"storeName":
"string",
-
"urls":
[
-
"string"
]
}
],
-
"name":
"string"
}
],
-
"maxWildcardCollections": 100,
-
"name":
"string",
-
"views":
[
-
{
-
"name":
"string",
-
"pipeline":
"string",
-
"source":
"string"
}
]
}
],
-
"stores":
[
-
{
-
"name":
"string",
-
"provider":
"string",
-
"additionalStorageClasses":
[
-
"STANDARD"
],
-
"bucket":
"string",
-
"delimiter":
"string",
-
"includeTags": false,
-
"prefix":
"string",
-
"public": false,
-
"region":
"US_GOV_WEST_1"
}
]
}
}
Downloads the query logs for the specified federated database instance. To use this resource, the requesting API Key must have the Project Atlas Admin or Project Data Access Read Write roles. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
tenantName
required
|
string
Human-readable label that identifies the federated database instance for which you want to download query logs. |
| endDate |
integer
<int64> 1199145600
Example:
endDate=1636481348
Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. |
| startDate |
integer
<int64> 1199145600
Example:
startDate=1636466948
Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns all private endpoints for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
[
-
{
-
"comment":
"string",
-
"endpointId":
"vpce-3bf78b0ddee411ba1",
-
"provider":
"AWS",
-
"type":
"DATA_LAKE"
}
]
Adds one private endpoint for Federated Database Instances and Online Archives to the specified projects. To use this resource, the requesting API Key must have the Project Atlas Admin or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Private endpoint for Federated Database Instances and Online Archives to add to the specified project.
| comment |
string
Human-readable string to associate with this private endpoint. |
|
endpointId
required
|
string
= 22 characters
^vpce-[0-9a-f]{17}$
Unique 22-character alphanumeric string that identifies the private endpoint. |
| provider |
string
Default:
"AWS"
Value:
"AWS"
Human-readable label that identifies the cloud service provider. Atlas Data Lake supports Amazon Web Services only. |
| type |
string
Default:
"DATA_LAKE"
Value:
"DATA_LAKE"
Human-readable label that identifies the resource type associated with this private endpoint. |
{
-
"comment":
"string",
-
"endpointId":
"vpce-3bf78b0ddee411ba1",
-
"provider":
"AWS",
-
"type":
"DATA_LAKE"
}
[
-
{
-
"comment":
"string",
-
"endpointId":
"vpce-3bf78b0ddee411ba1",
-
"provider":
"AWS",
-
"type":
"DATA_LAKE"
}
]
Removes one private endpoint for Federated Database Instances and Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
endpointId
required
|
string
= 22 characters
^vpce-[0-9a-f]{17}$
Unique 22-character alphanumeric string that identifies the private endpoint to remove. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint)",
-
"error":
401,
-
"errorCode":
"NOT_ORG_GROUP_CREATOR",
-
"parameters":
[
-
"EXAMPLE"
],
-
"reason":
"Unauthorized"
}
Returns the specified private endpoint for Federated Database Instances or Online Archives in the specified project. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
endpointId
required
|
string
= 22 characters
^vpce-[0-9a-f]{17}$
Unique 22-character alphanumeric string that identifies the private endpoint to return. Atlas Data Federation supports AWS private endpoints using the AWS PrivateLink feature. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"comment":
"string",
-
"endpointId":
"vpce-3bf78b0ddee411ba1",
-
"provider":
"AWS",
-
"type":
"DATA_LAKE"
}
Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.
Returns a list of Data Lake Pipelines. To use this resource, the requesting API Key must have the Project Read Only role.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
[
-
{
-
"_id":
"887821d389de9fe084df2bdf",
-
"createdDate":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"lastUpdatedDate":
"2019-08-24T14:15:22Z",
-
"name":
"string",
-
"sink":
{
-
"type":
"DLS"
},
-
"source":
{
-
"type":
"PERIODIC_CPS",
-
"clusterName":
"string",
-
"collectionName":
"string",
-
"databaseName":
"string",
-
"groupId":
"32b6e34b3d91647abb20e7b8"
},
-
"state":
"ACTIVE",
-
"transformations":
[
-
{
-
"field":
"string",
-
"type":
"EXCLUDE"
}
]
}
]
Creates one Data Lake Pipeline.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
Creates one Data Lake Pipeline.
| name |
string
Name of this Data Lake Pipeline. |
|
object
(Ingestion Destination)
Ingestion destination of a Data Lake Pipeline. |
|
|
object
(Ingestion Source)
Ingestion Source of a Data Lake Pipeline. |
|
|
Array of objects
(Field Transformation)
Fields to be excluded for this Data Lake Pipeline. |
{
-
"name":
"string",
-
"sink":
{
-
"type":
"DLS"
},
-
"source":
{
-
"type":
"PERIODIC_CPS",
-
"clusterName": "string",
-
"collectionName": "string",
-
"databaseName":
"string"
},
-
"transformations": [
-
{
-
"field":
"string",
-
"type":
"EXCLUDE"
}
]
}
{
-
"_id":
"887821d389de9fe084df2bdf",
-
"createdDate":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"lastUpdatedDate":
"2019-08-24T14:15:22Z",
-
"name":
"string",
-
"sink":
{
-
"type":
"DLS"
},
-
"source":
{
-
"type":
"PERIODIC_CPS",
-
"clusterName": "string",
-
"collectionName": "string",
-
"databaseName": "string",
-
"groupId":
"32b6e34b3d91647abb20e7b8"
},
-
"state":
"ACTIVE",
-
"transformations": [
-
{
-
"field":
"string",
-
"type":
"EXCLUDE"
}
]
}
Removes one Data Lake Pipeline.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
pipelineName
required
|
string
[ 1 .. 64 ] characters
^[^/\\ "$]{1,64}$
Human-readable label that identifies the Data Lake Pipeline. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint)",
-
"error":
401,
-
"errorCode":
"NOT_ORG_GROUP_CREATOR",
-
"parameters":
[
-
"EXAMPLE"
],
-
"reason":
"Unauthorized"
}
Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
pipelineName
required
|
string
[ 1 .. 64 ] characters
^[^/\\ "$]{1,64}$
Human-readable label that identifies the Data Lake Pipeline. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"_id":
"887821d389de9fe084df2bdf",
-
"createdDate":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"lastUpdatedDate":
"2019-08-24T14:15:22Z",
-
"name":
"string",
-
"sink":
{
-
"type":
"DLS"
},
-
"source":
{
-
"type":
"PERIODIC_CPS",
-
"clusterName": "string",
-
"collectionName": "string",
-
"databaseName": "string",
-
"groupId":
"32b6e34b3d91647abb20e7b8"
},
-
"state":
"ACTIVE",
-
"transformations": [
-
{
-
"field":
"string",
-
"type":
"EXCLUDE"
}
]
}
Updates one Data Lake Pipeline.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
pipelineName
required
|
string
[ 1 .. 64 ] characters
^[^/\\ "$]{1,64}$
Human-readable label that identifies the Data Lake Pipeline. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
Updates one Data Lake Pipeline.
| name |
string
Name of this Data Lake Pipeline. |
|
object
(Ingestion Destination)
Ingestion destination of a Data Lake Pipeline. |
|
|
object
(Ingestion Source)
Ingestion Source of a Data Lake Pipeline. |
|
|
Array of objects
(Field Transformation)
Fields to be excluded for this Data Lake Pipeline. |
{
-
"name":
"string",
-
"sink":
{
-
"type":
"DLS"
},
-
"source":
{
-
"type":
"PERIODIC_CPS",
-
"clusterName": "string",
-
"collectionName": "string",
-
"databaseName":
"string"
},
-
"transformations": [
-
{
-
"field":
"string",
-
"type":
"EXCLUDE"
}
]
}
{
-
"_id":
"887821d389de9fe084df2bdf",
-
"createdDate":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"lastUpdatedDate":
"2019-08-24T14:15:22Z",
-
"name":
"string",
-
"sink":
{
-
"type":
"DLS"
},
-
"source":
{
-
"type":
"PERIODIC_CPS",
-
"clusterName": "string",
-
"collectionName": "string",
-
"databaseName": "string",
-
"groupId":
"32b6e34b3d91647abb20e7b8"
},
-
"state":
"ACTIVE",
-
"transformations": [
-
{
-
"field":
"string",
-
"type":
"EXCLUDE"
}
]
}
Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting API Key must have the Project Read Only role.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
pipelineName
required
|
string
[ 1 .. 64 ] characters
^[^/\\ "$]{1,64}$
Human-readable label that identifies the Data Lake Pipeline. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
[
-
{
-
"frequencyInterval": 1,
-
"frequencyType": "DAILY",
-
"id":
"stringstringstringstring",
-
"retentionUnit": "DAYS",
-
"retentionValue": 0
}
]
Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting API Key must have the Project Read Only role.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
pipelineName
required
|
string
[ 1 .. 64 ] characters
^[^/\\ "$]{1,64}$
Human-readable label that identifies the Data Lake Pipeline. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| completedAfter |
string
<date-time>
Example:
completedAfter=2022-01-01T00:00:00.000Z
Date and time after which MongoDB Cloud created the snapshot. If specified, MongoDB Cloud returns available backup snapshots created after this time and date only. This parameter expresses its value in the ISO 8601 timestamp format in UTC. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"description":
"string",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"frequencyType":
"hourly",
-
"id":
"78e18e587716102f711a5bca",
-
"links":
[
-
],
-
"masterKeyUUID":
"72659f08-8b3c-4913-bb4e-a8a68e036502",
-
"mongodVersion":
"string",
-
"policyItems":
[
-
"f9fd98556fbe1a4eb3a396cb"
],
-
"snapshotType":
"onDemand",
-
"status":
"queued",
-
"storageSizeBytes": 0,
-
"type":
"REPLICA_SET"
}
],
-
"totalCount":
0
}
Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
pipelineName
required
|
string
[ 1 .. 64 ] characters
^[^/\\ "$]{1,64}$
Human-readable label that identifies the Data Lake Pipeline. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"_id":
"887821d389de9fe084df2bdf",
-
"createdDate":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"lastUpdatedDate":
"2019-08-24T14:15:22Z",
-
"name":
"string",
-
"sink":
{
-
"type":
"DLS"
},
-
"source":
{
-
"type":
"PERIODIC_CPS",
-
"clusterName": "string",
-
"collectionName": "string",
-
"databaseName": "string",
-
"groupId":
"32b6e34b3d91647abb20e7b8"
},
-
"state":
"ACTIVE",
-
"transformations": [
-
{
-
"field":
"string",
-
"type":
"EXCLUDE"
}
]
}
Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
pipelineName
required
|
string
[ 1 .. 64 ] characters
^[^/\\ "$]{1,64}$
Human-readable label that identifies the Data Lake Pipeline. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"_id":
"887821d389de9fe084df2bdf",
-
"createdDate":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"lastUpdatedDate":
"2019-08-24T14:15:22Z",
-
"name":
"string",
-
"sink":
{
-
"type":
"DLS"
},
-
"source":
{
-
"type":
"PERIODIC_CPS",
-
"clusterName": "string",
-
"collectionName": "string",
-
"databaseName": "string",
-
"groupId":
"32b6e34b3d91647abb20e7b8"
},
-
"state":
"ACTIVE",
-
"transformations": [
-
{
-
"field":
"string",
-
"type":
"EXCLUDE"
}
]
}
Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting API Key must have the Project Read Only role.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
pipelineName
required
|
string
[ 1 .. 64 ] characters
^[^/\\ "$]{1,64}$
Human-readable label that identifies the Data Lake Pipeline. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| createdBefore |
string
<date-time>
Example:
createdBefore=2022-01-01T00:00:00.000Z
If specified, Atlas returns only Data Lake Pipeline runs initiated before this time and date. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"_id":
"6300603d5fce7d9fd1543170",
-
"backupFrequencyType":
"HOURLY",
-
"createdDate":
"2019-08-24T14:15:22Z",
-
"datasetName":
"v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"lastUpdatedDate":
"2019-08-24T14:15:22Z",
-
"phase":
"SNAPSHOT",
-
"pipelineId":
"887821d389de9fe084df2bdf",
-
"snapshotId":
"78e18e587716102f711a5bca",
-
"state":
"PENDING",
-
"stats":
{
-
"bytesExported": 0,
-
"numDocs": 0
}
}
],
-
"totalCount":
0
}
Deletes dataset that Atlas generated during the specified pipeline run.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
pipelineName
required
|
string
[ 1 .. 64 ] characters
^[^/\\ "$]{1,64}$
Human-readable label that identifies the Data Lake Pipeline. |
|
pipelineRunId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
6300603d5fce7d9fd1543170
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
pipelineName
required
|
string
[ 1 .. 64 ] characters
^[^/\\ "$]{1,64}$
Human-readable label that identifies the Data Lake Pipeline. |
|
pipelineRunId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
6300603d5fce7d9fd1543170
Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"_id":
"6300603d5fce7d9fd1543170",
-
"backupFrequencyType": "HOURLY",
-
"createdDate":
"2019-08-24T14:15:22Z",
-
"datasetName":
"v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"lastUpdatedDate":
"2019-08-24T14:15:22Z",
-
"phase":
"SNAPSHOT",
-
"pipelineId":
"887821d389de9fe084df2bdf",
-
"snapshotId":
"78e18e587716102f711a5bca",
-
"state":
"PENDING",
-
"stats":
{
-
"bytesExported": 0,
-
"numDocs":
0
}
}
Triggers a Data Lake Pipeline ingestion of a specified snapshot.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
pipelineName
required
|
string
[ 1 .. 64 ] characters
^[^/\\ "$]{1,64}$
Human-readable label that identifies the Data Lake Pipeline. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Triggers a single ingestion run of a snapshot.
|
snapshotId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal character string that identifies the snapshot. |
{
-
"snapshotId":
"78e18e587716102f711a5bca"
}
{
-
"_id":
"6300603d5fce7d9fd1543170",
-
"backupFrequencyType": "HOURLY",
-
"createdDate":
"2019-08-24T14:15:22Z",
-
"datasetName":
"v1$atlas$snapshot$Cluster0$myDatabase$myCollection$19700101T000000Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"lastUpdatedDate":
"2019-08-24T14:15:22Z",
-
"phase":
"SNAPSHOT",
-
"pipelineId":
"887821d389de9fe084df2bdf",
-
"snapshotId":
"78e18e587716102f711a5bca",
-
"state":
"PENDING",
-
"stats":
{
-
"bytesExported": 0,
-
"numDocs":
0
}
}
Returns and edits the Encryption at Rest using Customer Key Management configuration.
Returns the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting API Key to have the Project Atlas Admin role.
LIMITED TO M10 OR GREATER: MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"awsKms":
{
-
"accessKeyID":
"019dd98d94b4bb778e7552e4",
-
"customerMasterKeyID": "string",
-
"enabled":
true,
-
"region":
"US_GOV_WEST_1",
-
"valid":
true
},
-
"azureKeyVault":
{
-
"azureEnvironment": "AZURE",
-
"clientID":
"5e4ea010-a908-45a1-a70b-ebd2e4feb055",
-
"enabled":
true,
-
-
"keyVaultName": "string",
-
"resourceGroupName": "string",
-
"subscriptionID":
"d0dd68eb-7e97-448c-b361-f7a7213dc7e2",
-
"tenantID":
"f95ac700-4c8f-4a38-a8d1-1582733edd5b",
-
"valid":
true
},
-
"googleCloudKms":
{
-
"enabled":
true,
-
"keyVersionResourceID":
"projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1",
-
"valid":
true
}
}
Updates the configuration for encryption at rest using the keys you manage through your cloud provider. MongoDB Cloud encrypts all storage even if you don't use your own key management. This resource requires the requesting API Key to have the Project Atlas Admin role.
LIMITED TO M10 OR GREATER: MongoDB Cloud limits this feature to dedicated cluster tiers of M10 and greater.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Required parameters depend on whether someone has enabled Encryption at Rest using Customer Key Management:
If you have enabled Encryption at Rest using Customer Key Management (CMK), Atlas requires all of the parameters for the desired encryption provider.
If you enabled Encryption at Rest using Customer Key Management, administrators can pass only the changed fields for the awsKms, azureKeyVault, or googleCloudKms object to update the configuration to this endpoint.
|
object
(ApiAtlasAWSKMSView)
Amazon Web Services (AWS) KMS configuration details and encryption at rest configuration set for the specified project. |
|
|
object
(ApiAtlasAzureKeyVaultView)
Details that define the configuration of Encryption at Rest using Azure Key Vault (AKV). |
|
|
object
(ApiAtlasGoogleCloudKMSView)
Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS). |
{
-
"awsKms":
{
-
"accessKeyID":
"019dd98d94b4bb778e7552e4",
-
"customerMasterKeyID": "string",
-
"enabled":
true,
-
"region":
"US_GOV_WEST_1",
-
"roleId":
"1ffa0028ed80f089383c05bf",
-
"secretAccessKey":
"string"
},
-
"azureKeyVault":
{
-
"azureEnvironment": "AZURE",
-
"clientID":
"5e4ea010-a908-45a1-a70b-ebd2e4feb055",
-
"enabled":
true,
-
-
"keyVaultName": "string",
-
"resourceGroupName": "string",
-
"secret":
"string",
-
"subscriptionID":
"d0dd68eb-7e97-448c-b361-f7a7213dc7e2",
-
"tenantID":
"f95ac700-4c8f-4a38-a8d1-1582733edd5b"
},
-
"googleCloudKms":
{
-
"enabled":
true,
-
"keyVersionResourceID":
"projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1",
-
"serviceAccountKey":
"string"
}
}
{
-
"awsKms":
{
-
"accessKeyID":
"019dd98d94b4bb778e7552e4",
-
"customerMasterKeyID": "string",
-
"enabled":
true,
-
"region":
"US_GOV_WEST_1",
-
"valid":
true
},
-
"azureKeyVault":
{
-
"azureEnvironment": "AZURE",
-
"clientID":
"5e4ea010-a908-45a1-a70b-ebd2e4feb055",
-
"enabled":
true,
-
-
"keyVaultName": "string",
-
"resourceGroupName": "string",
-
"subscriptionID":
"d0dd68eb-7e97-448c-b361-f7a7213dc7e2",
-
"tenantID":
"f95ac700-4c8f-4a38-a8d1-1582733edd5b",
-
"valid":
true
},
-
"googleCloudKms":
{
-
"enabled":
true,
-
"keyVersionResourceID":
"projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1",
-
"valid":
true
}
}
Returns events. This collection remains under revision and may change. Refer to the legacy documentation for this collection in the following link.
Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
This resource remains under revision and may change. Refer to the legacy documentation for this resource.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| clusterNames |
Array of strings[ items
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{... ]
Human-readable label that identifies the cluster. |
|
Agent Event Types (object) or Alert Audit Types (object) or Alert
Audit Types (object) or API User Event Types (object) or BAAS Event
Types (object) or Auto Indexing Event Types (object) or Automation
Config Event Types (object) or AWS Peer Vpc Audit Types (object) or
Azure Peer Network Audit Types (object) or Backup Event Types
(object) or BiConnector Event Types (object) or Billing Event Types
(object) or Cluster Connection Audit Types (object) or Cluster Event
Types (object) or Cps Backup Event Types (object) or Data Explorer
Accessed Event Types (object) or Disk Backup Event Types (object) or
Encryption Event Types (object) or Export Bucket Audit Types
(object) or FTS Index Audit Types (object) or GCP Peer Vpc Audit
Types (object) or Group Audit Types (object) or Group Event Types
(object) or Group Integration Event Types (object) or Host Event
Types (object) or Host Metric Event Types (object) or Index Build
Audit Types (object) or Log Collection Request Audit Types (object)
or Maintenance Window Config Audit Types (object) or NDS Audit Types
(object) or NDS Auto Scaling Audit Types (object) or NDS Serverless
Auto Scaling Audit Types (object) or NDS Serverless Instance Audit
Types (object) or NDS Auto Scaling Audit Types (object) or NDS
Tenant Endpoint Service Deployment Audit Types (object) or NDS x509
User Auth Event Types (object) or Online Archive Event Types
(object) or Private Link Audit Types (object) or ReplicaSet Event
Types (object) or Schedule Event Types (object) or Serverless
Deployment Audit Types (object) or Serverless Event Types (object)
or Support Case Event Types (object) or Support Event Types (object)
or Team Event Types (object) or Tenant Backup Event Types (object)
or User Event Types (object) or Version Audit Types (object)
(EventTypeForGroup)
Category of incident recorded at this moment in time. IMPORTANT: The complete list of event type values changes frequently. |
|
| includeRaw |
boolean
Default:
false
Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. |
| maxDate |
string
<date-time>
Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC. |
| minDate |
string
<date-time>
Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"apiKeyId":
"69f24ec71f746985759551c7",
-
"created":
"2019-08-24T14:15:22Z",
-
"eventTypeName":
"NEW_AGENT",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"375db9d4f7a4c3e01714d02a",
-
"isGlobalAdmin": false,
-
"links":
[
-
],
-
"orgId":
"4888442a3354817a7320eb61",
-
"publicKey":
"test.user@mongodb.com",
-
"raw":
{
-
"_t":
"ALERT_AUDIT",
-
"alertConfigId":
"adddde5af4ee4bd0b519375f",
-
"cid":
"32b6e34b3d91647abb20e7b8",
-
"cre":
"2019-08-24T14:15:22Z",
-
"description":
"Alert Acknowledged",
-
"gn":
"Test Project",
-
"id":
"375db9d4f7a4c3e01714d02a",
-
"orgId":
"4888442a3354817a7320eb61",
-
"orgName":
"Test Organization",
-
"severity":
"INFO"
},
-
"remoteAddress":
"216.172.40.186",
-
"userId":
"887821d389de9fe084df2bdf",
-
"username":
"test.user@mongodb.com"
}
],
-
"totalCount":
0
}
Returns one event for the specified project. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
This resource remains under revision and may change. Refer to the legacy documentation for this resource.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
eventId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the /events endpoint to retrieve all events to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| includeRaw |
boolean
Default:
false
Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. |
{
-
"apiKeyId":
"69f24ec71f746985759551c7",
-
"created":
"2019-08-24T14:15:22Z",
-
"eventTypeName": "NEW_AGENT",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"375db9d4f7a4c3e01714d02a",
-
"isGlobalAdmin": false,
-
"links":
[
-
],
-
"orgId":
"4888442a3354817a7320eb61",
-
"publicKey":
"test.user@mongodb.com",
-
"raw":
{
-
"_t":
"ALERT_AUDIT",
-
"alertConfigId":
"adddde5af4ee4bd0b519375f",
-
"cid":
"32b6e34b3d91647abb20e7b8",
-
"cre":
"2019-08-24T14:15:22Z",
-
"description":
"Alert Acknowledged",
-
"gn":
"Test Project",
-
"id":
"375db9d4f7a4c3e01714d02a",
-
"orgId":
"4888442a3354817a7320eb61",
-
"orgName":
"Test Organization",
-
"severity":
"INFO"
},
-
"remoteAddress":
"216.172.40.186",
-
"userId":
"887821d389de9fe084df2bdf",
-
"username":
"test.user@mongodb.com"
}
Returns all events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.
This resource remains under revision and may change. Refer to the legacy documentation for this resource.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
|
Alert Audit Types (object) or Alert Audit Types (object) or API
User Event Types (object) or Billing Event Types (object) or
Federation Settings Event Types (object) or Group Audit Types
(object) or Mlab Migration Audit Types (object) or NDS Audit Types
(object) or Org Event Types (object) or Partner Event Types (object)
or Policy Event Types (object) or Support Event Types (object) or
Team Event Types (object) or User Event Types (object)
(EventTypeForOrg)
Category of incident recorded at this moment in time. IMPORTANT: The complete list of event type values changes frequently. |
|
| includeRaw |
boolean
Default:
false
Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. |
| maxDate |
string
<date-time>
Date and time from when MongoDB Cloud stops returning events. This parameter uses the ISO 8601 timestamp format in UTC. |
| minDate |
string
<date-time>
Example:
minDate=2021-11-17T23:15:00.060Z
Date and time from when MongoDB Cloud starts returning events. This parameter uses the ISO 8601 timestamp format in UTC. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"apiKeyId":
"69f24ec71f746985759551c7",
-
"created":
"2019-08-24T14:15:22Z",
-
"eventTypeName":
"FEDERATION_SETTINGS_CREATED",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"375db9d4f7a4c3e01714d02a",
-
"isGlobalAdmin": false,
-
"links":
[
-
],
-
"orgId":
"4888442a3354817a7320eb61",
-
"publicKey":
"test.user@mongodb.com",
-
"raw":
{
-
"_t":
"ALERT_AUDIT",
-
"alertConfigId":
"adddde5af4ee4bd0b519375f",
-
"cid":
"32b6e34b3d91647abb20e7b8",
-
"cre":
"2019-08-24T14:15:22Z",
-
"description":
"Alert Acknowledged",
-
"gn":
"Test Project",
-
"id":
"375db9d4f7a4c3e01714d02a",
-
"orgId":
"4888442a3354817a7320eb61",
-
"orgName":
"Test Organization",
-
"severity":
"INFO"
},
-
"remoteAddress":
"216.172.40.186",
-
"userId":
"887821d389de9fe084df2bdf",
-
"username":
"test.user@mongodb.com"
}
],
-
"totalCount":
0
}
Returns one event for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.
This resource remains under revision and may change. Refer to the legacy documentation for this resource.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
|
eventId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the event that you want to return. Use the /events endpoint to retrieve all events to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| includeRaw |
boolean
Default:
false
Flag that indicates whether to include the raw document in the output. The raw document contains additional meta information about the event. |
{
-
"apiKeyId":
"69f24ec71f746985759551c7",
-
"created":
"2019-08-24T14:15:22Z",
-
"eventTypeName":
"FEDERATION_SETTINGS_CREATED",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"375db9d4f7a4c3e01714d02a",
-
"isGlobalAdmin": false,
-
"links":
[
-
],
-
"orgId":
"4888442a3354817a7320eb61",
-
"publicKey":
"test.user@mongodb.com",
-
"raw":
{
-
"_t":
"ALERT_AUDIT",
-
"alertConfigId":
"adddde5af4ee4bd0b519375f",
-
"cid":
"32b6e34b3d91647abb20e7b8",
-
"cre":
"2019-08-24T14:15:22Z",
-
"description":
"Alert Acknowledged",
-
"gn":
"Test Project",
-
"id":
"375db9d4f7a4c3e01714d02a",
-
"orgId":
"4888442a3354817a7320eb61",
-
"orgName":
"Test Organization",
-
"severity":
"INFO"
},
-
"remoteAddress":
"216.172.40.186",
-
"userId":
"887821d389de9fe084df2bdf",
-
"username":
"test.user@mongodb.com"
}
Returns, adds, edits, and removes federation-related features such as role mappings and connected organization configurations.
Deletes the federation settings instance and all associated data, including identity providers and domains. To use this resource, the requesting API Key must have the Organization Owner role in the last remaining connected organization. This resource doesn't require the API Key to have an Access List. Note: requests to this resource will fail if there is more than one connected organization in the federation.
|
federationSettingsId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
55fa922fb343282757d9554e
Unique 24-hexadecimal digit string that identifies your federation. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns all connected org configs in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected orgs. This resource doesn't require the API Key to have an Access List.
|
federationSettingsId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
55fa922fb343282757d9554e
Unique 24-hexadecimal digit string that identifies your federation. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
[
-
{
-
"domainAllowList":
[
-
"string"
],
-
"domainRestrictionEnabled": true,
-
"identityProviderId":
"stringstringstringst",
-
"orgId":
"4888442a3354817a7320eb61",
-
"postAuthRoleGrants":
[
-
"GLOBAL_AUTOMATION_ADMIN"
],
-
"roleMappings":
[
-
{
-
"externalGroupName":
"string",
-
"id":
"4faca5b098702de1952f4d09",
-
"roleAssignments":
[
-
{
-
"groupId":
{ },
-
"orgId":
{ },
-
"role":
"GLOBAL_AUTOMATION_ADMIN"
}
]
}
],
-
"userConflicts":
[
-
{
-
"emailAddress":
"user@example.com",
-
"federationSettingsId":
"55fa922fb343282757d9554e",
-
"firstName":
"string",
-
"lastName":
"string",
-
"userId":
"stringstringstringstring"
}
]
}
]
Removes one connected organization configuration from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This resource doesn't require the API Key to have an Access List. Note: This request fails if only one connected organization exists in the federation.
|
federationSettingsId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
55fa922fb343282757d9554e
Unique 24-hexadecimal digit string that identifies your federation. |
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the connected organization configuration to remove. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns the specified connected org config from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. This resource doesn't require the API Key to have an Access List.
|
federationSettingsId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
55fa922fb343282757d9554e
Unique 24-hexadecimal digit string that identifies your federation. |
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the connected organization configuration to return. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"domainAllowList": [
-
"string"
],
-
"domainRestrictionEnabled": true,
-
"identityProviderId":
"stringstringstringst",
-
"orgId":
"4888442a3354817a7320eb61",
-
"postAuthRoleGrants": [
-
"GLOBAL_AUTOMATION_ADMIN"
],
-
"roleMappings":
[
-
{
-
"externalGroupName":
"string",
-
"id":
"4faca5b098702de1952f4d09",
-
"roleAssignments":
[
-
{
-
"groupId":
{ },
-
"orgId":
{ },
-
"role":
"GLOBAL_AUTOMATION_ADMIN"
}
]
}
],
-
"userConflicts":
[
-
{
-
"emailAddress":
"user@example.com",
-
"federationSettingsId":
"55fa922fb343282757d9554e",
-
"firstName":
"string",
-
"lastName":
"string",
-
"userId":
"stringstringstringstring"
}
]
}
Updates one connected organization configuration from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This resource doesn't require the API Key to have an Access List.
Note If the organization configuration has no associated identity provider, you can't use this resource to update role mappings or post authorization role grants.
Note: The domainRestrictionEnabled field defaults to false if not provided in the request.
Note: If the identityProviderId field is not provided, you will disconnect the organization and the identity provider.
|
federationSettingsId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
55fa922fb343282757d9554e
Unique 24-hexadecimal digit string that identifies your federation. |
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the connected organization configuration to update. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
The connected organization configuration that you want to update.
| domainAllowList |
Array of strings
unique
Approved domains that restrict users who can join the organization based on their email address. |
|
domainRestrictionEnabled
required
|
boolean
Value that indicates whether domain restriction is enabled for this connected org. |
|
identityProviderId
required
|
string
= 20 characters
^([a-f0-9]{20})$
Unique 20-hexadecimal digit string that identifies the identity provider that this connected org config is associated with. |
| postAuthRoleGrants |
Array of strings
unique
Items
Enum:
"GLOBAL_AUTOMATION_ADMIN"
"GLOBAL_BACKUP_ADMIN"
"GLOBAL_METERING_USER"
"GLOBAL_METRICS_INTERNAL_USER"
"GLOBAL_MONITORING_ADMIN"
"GLOBAL_OWNER"
"GLOBAL_READ_ONLY"
"GLOBAL_USER_ADMIN"
"GLOBAL_USER_READ_ONLY"
"GLOBAL_ACCOUNT_SUSPENSION_ADMIN"
"GLOBAL_BILLING_ADMIN"
"GLOBAL_LEGAL_ADMIN"
"GLOBAL_FEATURE_FLAG_ADMIN"
"GLOBAL_ATLAS_TSE"
"GLOBAL_ATLAS_OPERATOR"
"GLOBAL_ATLAS_ADMIN"
"GLOBAL_STITCH_ADMIN"
"GLOBAL_CHARTS_ADMIN"
"GLOBAL_EXPERIMENT_ASSIGNMENT_USER"
"GLOBAL_STITCH_INTERNAL_ADMIN"
"GLOBAL_BAAS_FEATURE_ADMIN"
"GLOBAL_SECURITY_ADMIN"
"GLOBAL_QUERY_ENGINE_INTERNAL_ADMIN"
"GLOBAL_PROACTIVE_SUPPORT_ADMIN"
"GLOBAL_INFRASTRUCTURE_INTERNAL_ADMIN"
"GLOBAL_SALESFORCE_ADMIN"
"GLOBAL_SALESFORCE_READ_ONLY"
"GLOBAL_APP_SERVICES_CLUSTER_DEBUG_DATA_ACCESS"
"ORG_MEMBER"
"ORG_READ_ONLY"
"ORG_BILLING_ADMIN"
"ORG_GROUP_CREATOR"
"ORG_OWNER"
"ORG_TEAM_MEMBERS_ADMIN"
"GROUP_AUTOMATION_ADMIN"
"GROUP_BACKUP_ADMIN"
"GROUP_MONITORING_ADMIN"
"GROUP_OWNER"
"GROUP_READ_ONLY"
"GROUP_USER_ADMIN"
"GROUP_BILLING_ADMIN"
"GROUP_DATA_ACCESS_ADMIN"
"GROUP_DATA_ACCESS_READ_ONLY"
"GROUP_DATA_ACCESS_READ_WRITE"
"GROUP_CHARTS_ADMIN"
"GROUP_CLUSTER_MANAGER"
"GROUP_SEARCH_INDEX_EDITOR"
Atlas roles that are granted to a user in this organization after authenticating. |
|
Array of objects
(Federated Authentication Role Mapping)
unique
Role mappings that are configured in this organization. |
|
|
Array of objects
(Federated User)
List that contains the users who have an email address that doesn't match any domain on the allowed list. |
{
-
"domainAllowList": [
-
"string"
],
-
"domainRestrictionEnabled": true,
-
"identityProviderId":
"stringstringstringst",
-
"postAuthRoleGrants": [
-
"GLOBAL_AUTOMATION_ADMIN"
],
-
"roleMappings":
[
-
{
-
"externalGroupName":
"string",
-
"roleAssignments":
[
-
{
-
"role":
"GLOBAL_AUTOMATION_ADMIN"
}
]
}
],
-
"userConflicts":
[
-
{
-
"emailAddress":
"user@example.com",
-
"federationSettingsId":
"55fa922fb343282757d9554e",
-
"firstName":
"string",
-
"lastName":
"string"
}
]
}
{
-
"domainAllowList": [
-
"string"
],
-
"domainRestrictionEnabled": true,
-
"identityProviderId":
"stringstringstringst",
-
"orgId":
"4888442a3354817a7320eb61",
-
"postAuthRoleGrants": [
-
"GLOBAL_AUTOMATION_ADMIN"
],
-
"roleMappings":
[
-
{
-
"externalGroupName":
"string",
-
"id":
"4faca5b098702de1952f4d09",
-
"roleAssignments":
[
-
{
-
"groupId":
{ },
-
"orgId":
{ },
-
"role":
"GLOBAL_AUTOMATION_ADMIN"
}
]
}
],
-
"userConflicts":
[
-
{
-
"emailAddress":
"user@example.com",
-
"federationSettingsId":
"55fa922fb343282757d9554e",
-
"firstName":
"string",
-
"lastName":
"string",
-
"userId":
"stringstringstringstring"
}
]
}
Returns all role mappings from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This resource doesn't require the API Key to have an Access List.
|
federationSettingsId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
55fa922fb343282757d9554e
Unique 24-hexadecimal digit string that identifies your federation. |
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
[
-
{
-
"externalGroupName": "string",
-
"id":
"4faca5b098702de1952f4d09",
-
"roleAssignments":
[
-
{
-
"groupId":
{ },
-
"orgId":
{ },
-
"role":
"GLOBAL_AUTOMATION_ADMIN"
}
]
}
]
Adds one role mapping to the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This resource doesn't require the API Key to have an Access List.
|
federationSettingsId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
55fa922fb343282757d9554e
Unique 24-hexadecimal digit string that identifies your federation. |
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
The role mapping that you want to create.
|
externalGroupName
required
|
string
[ 1 .. 200 ] characters
Unique human-readable label that identifies the identity provider group to whichthis role mapping applies. |
|
Array of objects
(RoleAssignment)
unique
Atlas roles and the unique identifiers of the groups and organizations associated with each role. |
{
-
"externalGroupName": "string",
-
"roleAssignments": [
-
{
-
"role":
"GLOBAL_AUTOMATION_ADMIN"
}
]
}
{
-
"externalGroupName": "string",
-
"id":
"4faca5b098702de1952f4d09",
-
"roleAssignments": [
-
{
-
"groupId": { },
-
"orgId": { },
-
"role":
"GLOBAL_AUTOMATION_ADMIN"
}
]
}
Removes one role mapping in the specified organization from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This resource doesn't require the API Key to have an Access List.
|
federationSettingsId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
55fa922fb343282757d9554e
Unique 24-hexadecimal digit string that identifies your federation. |
|
id
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4faca5b098702de1952f4d09
Unique 24-hexadecimal digit string that identifies the role mapping that you want to remove. |
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns one role mapping from the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This resource doesn't require the API Key to have an Access List.
|
federationSettingsId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
55fa922fb343282757d9554e
Unique 24-hexadecimal digit string that identifies your federation. |
|
id
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4faca5b098702de1952f4d09
Unique 24-hexadecimal digit string that identifies the role mapping that you want to return. |
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"externalGroupName": "string",
-
"id":
"4faca5b098702de1952f4d09",
-
"roleAssignments": [
-
{
-
"groupId": { },
-
"orgId": { },
-
"role":
"GLOBAL_AUTOMATION_ADMIN"
}
]
}
Updates one role mapping in the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. This resource doesn't require the API Key to have an Access List.
|
federationSettingsId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
55fa922fb343282757d9554e
Unique 24-hexadecimal digit string that identifies your federation. |
|
id
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4faca5b098702de1952f4d09
Unique 24-hexadecimal digit string that identifies the role mapping that you want to update. |
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
The role mapping that you want to update.
|
externalGroupName
required
|
string
[ 1 .. 200 ] characters
Unique human-readable label that identifies the identity provider group to whichthis role mapping applies. |
|
Array of objects
(RoleAssignment)
unique
Atlas roles and the unique identifiers of the groups and organizations associated with each role. |
{
-
"externalGroupName": "string",
-
"roleAssignments": [
-
{
-
"role":
"GLOBAL_AUTOMATION_ADMIN"
}
]
}
{
-
"externalGroupName": "string",
-
"id":
"4faca5b098702de1952f4d09",
-
"roleAssignments": [
-
{
-
"groupId": { },
-
"orgId": { },
-
"role":
"GLOBAL_AUTOMATION_ADMIN"
}
]
}
Returns all identity providers in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. This resource doesn't require the API Key to have an Access List.
|
federationSettingsId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
55fa922fb343282757d9554e
Unique 24-hexadecimal digit string that identifies your federation. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
[
-
{
-
"acsUrl":
"string",
-
"associatedDomains":
[
-
"string"
],
-
"associatedOrgs":
[
-
{
-
"domainAllowList":
[
-
"string"
],
-
"domainRestrictionEnabled": true,
-
"identityProviderId":
"stringstringstringst",
-
"orgId":
"4888442a3354817a7320eb61",
-
"postAuthRoleGrants":
[
-
"GLOBAL_AUTOMATION_ADMIN"
],
-
"roleMappings":
[
-
{
-
"externalGroupName":
"string",
-
"id":
"4faca5b098702de1952f4d09",
-
"roleAssignments":
[
-
{
-
"groupId":
{ },
-
"orgId":
{ },
-
"role":
"GLOBAL_AUTOMATION_ADMIN"
}
]
}
],
-
"userConflicts":
[
-
{
-
"emailAddress":
"user@example.com",
-
"federationSettingsId":
"55fa922fb343282757d9554e",
-
"firstName":
"string",
-
"lastName":
"string",
-
"userId":
"stringstringstringstring"
}
]
}
],
-
"audienceUri": "string",
-
"displayName": "string",
-
"issuerUri": "string",
-
"oktaIdpId":
"stringstringstringst",
-
"pemFileInfo":
{
-
"certificates":
[
-
{
-
"notAfter":
"2019-08-24T14:15:22Z",
-
"notBefore":
"2019-08-24T14:15:22Z"
}
],
-
"fileName":
"string"
},
-
"requestBinding":
"HTTP-POST",
-
"responseSignatureAlgorithm": "SHA-1",
-
"ssoDebugEnabled": true,
-
"ssoUrl":
"string",
-
"status":
"ACTIVE"
}
]
Returns one identity provider from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. This resource doesn't require the API Key to have an Access List.
|
federationSettingsId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
55fa922fb343282757d9554e
Unique 24-hexadecimal digit string that identifies your federation. |
|
identityProviderId
required
|
string
= 20 characters
^([a-f0-9]{20})$
Example:
c2777a9eca931f29fc2f
Unique 20-hexadecimal digit string that identifies the identity provider. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"acsUrl":
"string",
-
"associatedDomains": [
-
"string"
],
-
"associatedOrgs":
[
-
{
-
"domainAllowList":
[
-
"string"
],
-
"domainRestrictionEnabled": true,
-
"identityProviderId":
"stringstringstringst",
-
"orgId":
"4888442a3354817a7320eb61",
-
"postAuthRoleGrants":
[
-
"GLOBAL_AUTOMATION_ADMIN"
],
-
"roleMappings":
[
-
{
-
"externalGroupName":
"string",
-
"id":
"4faca5b098702de1952f4d09",
-
"roleAssignments":
[
-
{
-
"groupId":
{ },
-
"orgId":
{ },
-
"role":
"GLOBAL_AUTOMATION_ADMIN"
}
]
}
],
-
"userConflicts":
[
-
{
-
"emailAddress":
"user@example.com",
-
"federationSettingsId":
"55fa922fb343282757d9554e",
-
"firstName":
"string",
-
"lastName":
"string",
-
"userId":
"stringstringstringstring"
}
]
}
],
-
"audienceUri":
"string",
-
"displayName":
"string",
-
"issuerUri":
"string",
-
"oktaIdpId":
"stringstringstringst",
-
"pemFileInfo":
{
-
"certificates":
[
-
{
-
"notAfter":
"2019-08-24T14:15:22Z",
-
"notBefore":
"2019-08-24T14:15:22Z"
}
],
-
"fileName":
"string"
},
-
"requestBinding":
"HTTP-POST",
-
"responseSignatureAlgorithm": "SHA-1",
-
"ssoDebugEnabled": true,
-
"ssoUrl":
"string",
-
"status":
"ACTIVE"
}
Updates one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. This resource doesn't require the API Key to have an Access List.
|
federationSettingsId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
55fa922fb343282757d9554e
Unique 24-hexadecimal digit string that identifies your federation. |
|
identityProviderId
required
|
string
= 20 characters
^([a-f0-9]{20})$
Example:
c2777a9eca931f29fc2f
Unique 20-hexadecimal digit string that identifies the identity provider. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
The identity provider that you want to update.
| associatedDomains |
Array of strings
unique
List that contains the domains associated with the identity provider. |
| displayName |
string
[ 1 .. 50 ] characters
Human-readable label that identifies the identity provider. |
| issuerUri |
string
Unique string that identifies the issuer of the SAML Assertion. |
|
object
(PemFileInfo)
PEM file information for the identity provider's certificates. |
|
| requestBinding |
string
Enum:
"HTTP-POST"
"HTTP-REDIRECT"
SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request. |
| responseSignatureAlgorithm |
string
Enum:
"SHA-1"
"SHA-256"
Signature algorithm that Federated Authentication uses to encrypt the identity provider signature. |
|
ssoDebugEnabled
required
|
boolean
Flag that indicates whether the identity provider has SSO debug enabled. |
| ssoUrl |
string
Unique string that identifies the intended audience of the SAML assertion. |
| status |
string
Enum:
"ACTIVE"
"INACTIVE"
String enum that indicates whether the identity provider is active. |
{
-
"associatedDomains": [
-
"string"
],
-
"displayName":
"string",
-
"issuerUri":
"urn:idp:default",
-
"pemFileInfo":
{
-
"certificates":
[
-
{
-
"content":
"string",
-
"notAfter":
"2019-08-24T14:15:22Z",
-
"notBefore":
"2019-08-24T14:15:22Z"
}
],
-
"fileName":
"string"
},
-
"requestBinding":
"HTTP-POST",
-
"responseSignatureAlgorithm": "SHA-1",
-
"ssoDebugEnabled": true,
-
-
"status":
"ACTIVE"
}
{
-
"acsUrl":
"string",
-
"associatedDomains": [
-
"string"
],
-
"associatedOrgs":
[
-
{
-
"domainAllowList":
[
-
"string"
],
-
"domainRestrictionEnabled": true,
-
"identityProviderId":
"stringstringstringst",
-
"orgId":
"4888442a3354817a7320eb61",
-
"postAuthRoleGrants":
[
-
"GLOBAL_AUTOMATION_ADMIN"
],
-
"roleMappings":
[
-
{
-
"externalGroupName":
"string",
-
"id":
"4faca5b098702de1952f4d09",
-
"roleAssignments":
[
-
{
-
"groupId":
{ },
-
"orgId":
{ },
-
"role":
"GLOBAL_AUTOMATION_ADMIN"
}
]
}
],
-
"userConflicts":
[
-
{
-
"emailAddress":
"user@example.com",
-
"federationSettingsId":
"55fa922fb343282757d9554e",
-
"firstName":
"string",
-
"lastName":
"string",
-
"userId":
"stringstringstringstring"
}
]
}
],
-
"audienceUri":
"string",
-
"displayName":
"string",
-
"issuerUri":
"string",
-
"oktaIdpId":
"stringstringstringst",
-
"pemFileInfo":
{
-
"certificates":
[
-
{
-
"notAfter":
"2019-08-24T14:15:22Z",
-
"notBefore":
"2019-08-24T14:15:22Z"
}
],
-
"fileName":
"string"
},
-
"requestBinding":
"HTTP-POST",
-
"responseSignatureAlgorithm": "SHA-1",
-
"ssoDebugEnabled": true,
-
"ssoUrl":
"string",
-
"status":
"ACTIVE"
}
Returns the metadata of one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. This resource doesn't require the API Key to have an Access List.
|
federationSettingsId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
55fa922fb343282757d9554e
Unique 24-hexadecimal digit string that identifies your federation. |
|
identityProviderId
required
|
string
= 20 characters
^([a-f0-9]{20})$
Example:
c2777a9eca931f29fc2f
Unique 20-hexadecimal digit string that identifies the identity provider. |
"string"
Returns information about the federation settings for the specified organization. To use this resource, the requesting API Key must have the Organization Owner role in the connected org. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"federatedDomains": [
-
"string"
],
-
"hasRoleMappings": true,
-
"id":
"55fa922fb343282757d9554e",
-
"identityProviderId":
"c2777a9eca931f29fc2f",
-
"identityProviderStatus": "ACTIVE"
}
Returns, adds, and removes Global Cluster managed namespaces and custom zone mappings.
Returns all managed namespaces and custom zone mappings for the specified global cluster. Managed namespaces identify collections using the database name, the dot separator, and the collection name. Custom zone mappings matches ISO 3166-2 location codes to zones in your global cluster. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies this global cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"customZoneMapping": {
-
"property1": { },
-
"property2": { }
},
-
"managedNamespaces": [
-
{
-
"collection":
"string",
-
"customShardKey":
"string",
-
"db":
"string"
}
]
}
Removes all custom zone mappings for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. Removing the custom zone mappings restores the default mapping. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies this global cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"customZoneMapping": {
-
"property1": { },
-
"property2": { }
},
-
"managedNamespaces": [
-
{
-
"collection":
"string",
-
"customShardKey":
"string",
-
"db":
"string"
}
]
}
Add one or more custom zone mappings to the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies this global cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Custom zone mapping to add to the specified global cluster.
|
required
|
Array of objects
(Global Cluster Zone)
List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to the human-readable label for the desired custom zone. MongoDB Cloud maps the ISO 3166-1a2 code to the nearest geographical zone by default. Include this parameter to override the default mappings. This parameter returns an empty object if no custom zones exist. |
{
-
"customZoneMappings": [
-
{
-
"location":
"string",
-
"zone":
"string"
}
]
}
{
-
"customZoneMapping": {
-
"property1": { },
-
"property2": { }
},
-
"managedNamespaces": [
-
{
-
"collection":
"string",
-
"customShardKey":
"string",
-
"db":
"string"
}
]
}
Removes one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. Deleting a managed namespace does not remove the associated collection or data. To use this resource, the requesting API Key must have the Project Data Access Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies this global cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| db |
string
Human-readable label that identifies the database that contains the collection. |
| collection |
string
Human-readable label that identifies the collection associated with the managed namespace. |
{
-
"customZoneMapping": {
-
"property1": { },
-
"property2": { }
},
-
"managedNamespaces": [
-
{
-
"collection":
"string",
-
"customShardKey":
"string",
-
"db":
"string"
}
]
}
Creates one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting API Key must have the Project Data Access Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies this global cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Managed namespace to create within the specified global cluster.
|
collection
required
|
string
Human-readable label of the collection to manage for this Global Cluster. |
|
db
required
|
string
Human-readable label of the database to manage for this Global Cluster. |
| isCustomShardKeyHashed |
boolean
Default:
false
Flag that indicates whether someone hashed the custom shard key for
the specified collection. If you set this value to
|
| isShardKeyUnique |
boolean
Default:
false
Flag that indicates whether someone
hashed
the custom shard key. If this parameter returns |
| numInitialChunks |
integer
<int64>
<= 8192
Minimum number of chunks to create initially when sharding an empty collection with a hashed shard key. |
| presplitHashedZones |
boolean
Default:
false
Flag that indicates whether MongoDB Cloud should create and distribute initial chunks for an empty or non-existing collection. MongoDB Cloud distributes data based on the defined zones and zone ranges for the collection. |
{
-
"collection":
"string",
-
"db":
"string",
-
"isCustomShardKeyHashed": false,
-
"isShardKeyUnique": false,
-
"numInitialChunks": 8192,
-
"presplitHashedZones": false
}
{
-
"customZoneMapping": {
-
"property1": { },
-
"property2": { }
},
-
"managedNamespaces": [
-
{
-
"collection":
"string",
-
"customShardKey":
"string",
-
"db":
"string"
}
]
}
Removes all custom zone mappings for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. Removing the custom zone mappings restores the default mapping. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies this advanced cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"customZoneMapping": {
-
"property1": { },
-
"property2": { }
},
-
"managedNamespaces": [
-
{
-
"collection":
"string",
-
"customShardKey":
"string",
-
"db":
"string"
}
]
}
Removes one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. Deleting a managed namespace does not remove the associated collection or data. To use this resource, the requesting API Key must have the Project Data Access Admin role. This resource doesn't require the API Key to have an Access List.
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies this advanced cluster. |
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| db |
string
Human-readable label that identifies the database that contains the collection. |
| collection |
string
Human-readable label that identifies the collection associated with the managed namespace. |
{
-
"customZoneMapping": {
-
"property1": { },
-
"property2": { }
},
-
"managedNamespaces": [
-
{
-
"collection":
"string",
-
"customShardKey":
"string",
-
"db":
"string",
-
"isCustomShardKeyHashed": false,
-
"isShardKeyUnique": false,
-
"numInitialChunks": 0,
-
"presplitHashedZones": false
}
]
}
Returns all invoices that MongoDB issued to the specified organization. This list includes all invoices regardless of invoice status. To use this resource, the requesting API Key must have the Organization Member role. If you have a cross-organization setup, to view linked invoices, you must have an Organization Billing Admin or Organization Owner role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"amountBilledCents": 0,
-
"amountPaidCents": 0,
-
"created":
"2019-08-24T14:15:22Z",
-
"creditsCents": 0,
-
"endDate":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"217a865625b2bad3b9a1e93d",
-
"lineItems":
[
-
{
-
"clusterName":
"string",
-
"created":
"2019-08-24T14:15:22Z",
-
"discountCents":
0,
-
"endDate":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"groupName":
"string",
-
"note":
"string",
-
"percentDiscount":
0,
-
"quantity":
0,
-
"sku":
"CLASSIC_BACKUP_OPLOG",
-
"startDate":
"2019-08-24T14:15:22Z",
-
"stitchAppName":
"string",
-
"tierLowerBound":
0,
-
"tierUpperBound":
0,
-
"totalPriceCents":
0,
-
"unit":
"string",
-
"unitPriceDollars":
0
}
],
-
"linkedInvoices":
[
-
{ }
],
-
"links":
[
-
],
-
"orgId":
"4888442a3354817a7320eb61",
-
"payments":
[
-
{
-
"amountBilledCents":
0,
-
"amountPaidCents":
0,
-
"created":
"2019-08-24T14:15:22Z",
-
"id":
"6fb669797183aa180bc5c09a",
-
"salesTaxCents":
0,
-
"statusName":
"NEW",
-
"subtotalCents":
0,
-
"updated":
"2019-08-24T14:15:22Z"
}
],
-
"refunds":
[
-
{
-
"amountCents":
0,
-
"created":
"2019-08-24T14:15:22Z",
-
"paymentId":
"stringstringstringstring",
-
"reason":
"string"
}
],
-
"salesTaxCents": 0,
-
"startDate":
"2019-08-24T14:15:22Z",
-
"startingBalanceCents": 0,
-
"statusName":
"PENDING",
-
"subtotalCents": 0,
-
"updated":
"2019-08-24T14:15:22Z"
}
],
-
"totalCount":
0
}
Returns all invoices accruing charges for the current billing cycle for the specified organization. To use this resource, the requesting API Key must have the Organization Member role. If you have a cross-organization setup, to view linked invoices, you must have an Organization Billing Admin or Organization Owner Role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"amountBilledCents": 0,
-
"amountPaidCents": 0,
-
"created":
"2019-08-24T14:15:22Z",
-
"creditsCents": 0,
-
"endDate":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"217a865625b2bad3b9a1e93d",
-
"lineItems":
[
-
{
-
"clusterName":
"string",
-
"created":
"2019-08-24T14:15:22Z",
-
"discountCents":
0,
-
"endDate":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"groupName":
"string",
-
"note":
"string",
-
"percentDiscount":
0,
-
"quantity":
0,
-
"sku":
"CLASSIC_BACKUP_OPLOG",
-
"startDate":
"2019-08-24T14:15:22Z",
-
"stitchAppName":
"string",
-
"tierLowerBound":
0,
-
"tierUpperBound":
0,
-
"totalPriceCents":
0,
-
"unit":
"string",
-
"unitPriceDollars":
0
}
],
-
"linkedInvoices":
[
-
{ }
],
-
"links":
[
-
],
-
"orgId":
"4888442a3354817a7320eb61",
-
"payments":
[
-
{
-
"amountBilledCents":
0,
-
"amountPaidCents":
0,
-
"created":
"2019-08-24T14:15:22Z",
-
"id":
"6fb669797183aa180bc5c09a",
-
"salesTaxCents":
0,
-
"statusName":
"NEW",
-
"subtotalCents":
0,
-
"updated":
"2019-08-24T14:15:22Z"
}
],
-
"refunds":
[
-
{
-
"amountCents":
0,
-
"created":
"2019-08-24T14:15:22Z",
-
"paymentId":
"stringstringstringstring",
-
"reason":
"string"
}
],
-
"salesTaxCents": 0,
-
"startDate":
"2019-08-24T14:15:22Z",
-
"startingBalanceCents": 0,
-
"statusName":
"PENDING",
-
"subtotalCents": 0,
-
"updated":
"2019-08-24T14:15:22Z"
}
],
-
"totalCount":
0
}
Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. To use this resource, the requesting API Key must have the Organization Member role. If you have a cross-organization setup, you can query for a linked invoice if you have an Organization Billing Admin or Organization Owner role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
|
invoiceId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"amountBilledCents": 0,
-
"amountPaidCents": 0,
-
"created":
"2019-08-24T14:15:22Z",
-
"creditsCents":
0,
-
"endDate":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"217a865625b2bad3b9a1e93d",
-
"lineItems":
[
-
{
-
"clusterName":
"string",
-
"created":
"2019-08-24T14:15:22Z",
-
"discountCents": 0,
-
"endDate":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"groupName":
"string",
-
"note":
"string",
-
"percentDiscount": 0,
-
"quantity": 0,
-
"sku":
"CLASSIC_BACKUP_OPLOG",
-
"startDate":
"2019-08-24T14:15:22Z",
-
"stitchAppName":
"string",
-
"tierLowerBound": 0,
-
"tierUpperBound": 0,
-
"totalPriceCents": 0,
-
"unit":
"string",
-
"unitPriceDollars": 0
}
],
-
"linkedInvoices":
[
-
{ }
],
-
"links":
[
-
],
-
"orgId":
"4888442a3354817a7320eb61",
-
"payments":
[
-
{
-
"amountBilledCents": 0,
-
"amountPaidCents": 0,
-
"created":
"2019-08-24T14:15:22Z",
-
"id":
"6fb669797183aa180bc5c09a",
-
"salesTaxCents": 0,
-
"statusName":
"NEW",
-
"subtotalCents": 0,
-
"updated":
"2019-08-24T14:15:22Z"
}
],
-
"refunds":
[
-
{
-
"amountCents": 0,
-
"created":
"2019-08-24T14:15:22Z",
-
"paymentId":
"stringstringstringstring",
-
"reason":
"string"
}
],
-
"salesTaxCents":
0,
-
"startDate":
"2019-08-24T14:15:22Z",
-
"startingBalanceCents": 0,
-
"statusName":
"PENDING",
-
"subtotalCents":
0,
-
"updated":
"2019-08-24T14:15:22Z"
}
Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting API Key must have the Organization Member role. If you have a cross-organization setup, you can query for a linked invoice if you have an Organization Billing Admin or Organization Owner Role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
|
invoiceId
required
|
string[0-9a-f]+
Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint)",
-
"error":
401,
-
"errorCode":
"NOT_ORG_GROUP_CREATOR",
-
"parameters":
[
-
"EXAMPLE"
],
-
"reason":
"Unauthorized"
}
Returns the current LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"customerX509":
{
-
"cas":
"string",
-
"links":
[
-
]
},
-
"ldap":
{
-
"authenticationEnabled": true,
-
"authorizationEnabled": true,
-
"authzQueryTemplate":
"{USER}?memberOf?base",
-
"bindUsername":
"CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
-
"caCertificate": "string",
-
"hostname":
"string",
-
"links":
[
-
],
-
"port":
636,
-
"userToDNMapping":
[
-
{
-
"ldapQuery":
"string",
-
"match":
"(.*)",
-
"substitution":
"CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com"
}
]
},
-
"links":
[
-
]
}
Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
Updating this configuration triggers a rolling restart of the database.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Updates the LDAP configuration for the specified project.
|
object
(Database User TLS Certificate Settings)
Settings to configure TLS Certificates for database users. |
|
|
object
(LDAP Security Settings)
Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details that apply to the specified project. |
{
-
"customerX509":
{
-
"cas":
"string"
},
-
"ldap":
{
-
"authenticationEnabled": true,
-
"authorizationEnabled": true,
-
"authzQueryTemplate":
"{USER}?memberOf?base",
-
"bindPassword": "string",
-
"bindUsername":
"CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
-
"caCertificate": "string",
-
"hostname":
"string",
-
"port":
636,
-
"userToDNMapping":
[
-
{
-
"ldapQuery":
"string",
-
"match":
"(.*)",
-
"substitution":
"CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com"
}
]
}
}
{
-
"customerX509":
{
-
"cas":
"string",
-
"links":
[
-
]
},
-
"ldap":
{
-
"authenticationEnabled": true,
-
"authorizationEnabled": true,
-
"authzQueryTemplate":
"{USER}?memberOf?base",
-
"bindUsername":
"CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
-
"caCertificate": "string",
-
"hostname":
"string",
-
"links":
[
-
],
-
"port":
636,
-
"userToDNMapping":
[
-
{
-
"ldapQuery":
"string",
-
"match":
"(.*)",
-
"substitution":
"CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com"
}
]
},
-
"links":
[
-
]
}
Removes the current LDAP Distinguished Name mapping captured in the
userToDNMapping document from the LDAP configuration for the
specified project. To use this resource, the requesting API Key must have the
Project Atlas Admin role. This resource doesn't require the API Key to
have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) Cannot find resource
AWS",
-
"error":
404,
-
"errorCode":
"RESOURCE_NOT_FOUND",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Not Found"
}
Verifies the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
The LDAP configuration for the specified project that you want to verify.
| authzQueryTemplate |
string
Default:
"{USER}?memberOf?base"
Lightweight Directory Access Protocol (LDAP) query template that MongoDB Cloud applies to create an LDAP query to return the LDAP groups associated with the authenticated MongoDB user. MongoDB Cloud uses this parameter only for user authorization.
Use the |
|
bindPassword
required
|
string
Password that MongoDB Cloud uses to authenticate the bindUsername. |
|
bindUsername
required
|
string^(?:(?<cn>CN=(?<name>[^,]*)),)?(?:(?<path>(?:...
Full Distinguished Name (DN) of the Lightweight Directory Access Protocol (LDAP) user that MongoDB Cloud uses to connect to the LDAP host. LDAP distinguished names must be formatted according to RFC 2253. |
| caCertificate |
string
Certificate Authority (CA) certificate that MongoDB Cloud uses to
verify the identity of the Lightweight Directory Access Protocol
(LDAP) host. MongoDB Cloud allows self-signed certificates. To
delete an assigned value, pass an empty string:
|
|
hostname
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Human-readable label that identifies the hostname or Internet Protocol (IP) address of the Lightweight Directory Access Protocol (LDAP) host. This host must have access to the internet or have a Virtual Private Cloud (VPC) peering connection to your cluster. |
|
port
required
|
integer
<int32>
Default:
636
IANA port to which the Lightweight Directory Access Protocol (LDAP) host listens for client connections. |
{
-
"authzQueryTemplate":
"{USER}?memberOf?base",
-
"bindPassword":
"string",
-
"bindUsername":
"CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
-
"caCertificate":
"string",
-
"hostname":
"string",
-
"port":
636
}
{
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"links":
[
-
],
-
"request":
{
-
"bindUsername":
"CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
-
"caCertificate": "string",
-
"hostname":
"string",
-
"links":
[
-
],
-
"port":
636
},
-
"requestId":
"b9ac4fd1a309d8d20879cddd",
-
"status":
"FAIL",
-
"validations":
[
-
{
-
"status":
"FAIL",
-
"validationType":
"AUTHENTICATE"
}
]
}
Returns the status of one request to verify one LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
requestId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique string that identifies the request to verify an LDAP configuration. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"links":
[
-
],
-
"request":
{
-
"bindUsername":
"CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
-
"caCertificate": "string",
-
"hostname":
"string",
-
"links":
[
-
],
-
"port":
636
},
-
"requestId":
"b9ac4fd1a309d8d20879cddd",
-
"status":
"FAIL",
-
"validations":
[
-
{
-
"status":
"FAIL",
-
"validationType":
"AUTHENTICATE"
}
]
}
Returns all legacy backup checkpoints for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster that contains the checkpoints that you want to return. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"clusterId":
"5faec72692cee15b51eb22a4",
-
"completed":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"866164af7f46083e4f3a964b",
-
"links":
[
-
],
-
"parts":
[
-
{
-
"replicaSetName":
"string",
-
"shardName":
"string",
-
"tokenDiscovered":
true,
-
"tokenTimestamp":
{
-
"date":
"2019-08-24T14:15:22Z",
-
"increment":
1199145600
},
-
"typeName":
"REPLICA_SET"
}
],
-
"restorable": true,
-
"started":
"2019-08-24T14:15:22Z",
-
"timestamp":
"2019-08-24T14:15:22Z"
}
],
-
"totalCount":
0
}
Returns one legacy backup checkpoint for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
checkpointId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the checkpoint. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster that contains the checkpoints that you want to return. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"clusterId":
"5faec72692cee15b51eb22a4",
-
"completed":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"866164af7f46083e4f3a964b",
-
"links":
[
-
],
-
"parts":
[
-
{
-
"replicaSetName":
"string",
-
"shardName":
"string",
-
"tokenDiscovered": true,
-
"tokenTimestamp":
{
-
"date":
"2019-08-24T14:15:22Z",
-
"increment":
1199145600
},
-
"typeName":
"REPLICA_SET"
}
],
-
"restorable":
true,
-
"started":
"2019-08-24T14:15:22Z",
-
"timestamp":
"2019-08-24T14:15:22Z"
}
Returns all legacy backup restore jobs for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster with the snapshot you want to return. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| batchId |
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the batch of restore jobs to return. Timestamp in ISO 8601 date and time format in UTC when creating a restore job for a sharded cluster, Application creates a separate job for each shard, plus another for the config host. Each of these jobs comprise one batch. A restore job for a replica set can't be part of a batch. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"batchId":
"871c3da1c32654c807e5d480",
-
"clusterId":
"5faec72692cee15b51eb22a4",
-
"clusterName":
"string",
-
"created":
"2019-08-24T14:15:22Z",
-
"delivery":
{
-
"authHeader":
"string",
-
"authValue":
"string",
-
"expirationHours": 1,
-
"expires":
"2019-08-24T14:15:22Z",
-
"maxDownloads": 1,
-
"methodName":
"CLIENT_PIT_HTTP",
-
"statusName":
"NOT_STARTED",
-
"targetClusterId":
"aff8ccf466da6f87c4b0736b",
-
"targetClusterName":
"string",
-
"targetGroupId":
"ca4d8a18b96b317422974eec",
-
"url":
"string",
-
"urlV2":
"string"
},
-
"encryptionEnabled": true,
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"hashes":
[
-
{
-
"fileName":
"string",
-
"hash":
"string",
-
"links":
[
-
],
-
"typeName":
"SHA1"
}
],
-
"id":
"e7cb93f480f357b5139ccf37",
-
"links":
[
-
],
-
"masterKeyUUID":
"72659f08-8b3c-4913-bb4e-a8a68e036502",
-
"snapshotId":
"78e18e587716102f711a5bca",
-
"statusName":
"IN_PROGRESS",
-
"timestamp":
{
-
"date":
"2019-08-24T14:15:22Z",
-
"increment":
1199145600
}
}
],
-
"totalCount":
0
}
Returns one legacy backup restore job for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster with the snapshot you want to return. |
|
jobId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the restore job. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"batchId":
"871c3da1c32654c807e5d480",
-
"clusterId":
"5faec72692cee15b51eb22a4",
-
"clusterName":
"string",
-
"created":
"2019-08-24T14:15:22Z",
-
"delivery":
{
-
"authHeader": "string",
-
"authValue": "string",
-
"expirationHours": 1,
-
"expires":
"2019-08-24T14:15:22Z",
-
"maxDownloads": 1,
-
"methodName":
"CLIENT_PIT_HTTP",
-
"statusName":
"NOT_STARTED",
-
"targetClusterId":
"aff8ccf466da6f87c4b0736b",
-
"targetClusterName": "string",
-
"targetGroupId":
"ca4d8a18b96b317422974eec",
-
"url":
"string",
-
"urlV2":
"string"
},
-
"encryptionEnabled": true,
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"hashes":
[
-
{
-
"fileName":
"string",
-
"hash":
"string",
-
"links":
[
-
],
-
"typeName":
"SHA1"
}
],
-
"id":
"e7cb93f480f357b5139ccf37",
-
"links":
[
-
],
-
"masterKeyUUID":
"72659f08-8b3c-4913-bb4e-a8a68e036502",
-
"snapshotId":
"78e18e587716102f711a5bca",
-
"statusName":
"IN_PROGRESS",
-
"timestamp":
{
-
"date":
"2019-08-24T14:15:22Z",
-
"increment": 1199145600
}
}
Returns the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster with the snapshot you want to return. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"clusterCheckpointIntervalMin": 15,
-
"clusterId":
"5faec72692cee15b51eb22a4",
-
"dailySnapshotRetentionDays": 0,
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"links":
[
-
],
-
"monthlySnapshotRetentionMonths": 0,
-
"pointInTimeWindowHours": 0,
-
"snapshotIntervalHours": 6,
-
"snapshotRetentionDays": 2,
-
"weeklySnapshotRetentionWeeks": 0
}
Update the snapshot schedule for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster with the snapshot you want to return. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Update the snapshot schedule for one cluster in the specified project.
|
clusterCheckpointIntervalMin
required
|
integer
<int32>
Enum:
15
30
60
Quantity of time expressed in minutes between successive cluster checkpoints. This parameter applies only to sharded clusters. This number determines the granularity of continuous cloud backups for sharded clusters. |
|
clusterId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the cluster with the snapshot you want to return. |
|
dailySnapshotRetentionDays
required
|
integer
<int32>
Enum:
0
3
4
5
6
7
15
30
60
90
120
180
360
Quantity of time to keep daily snapshots. MongoDB Cloud expresses
this value in days. Set this value to |
|
monthlySnapshotRetentionMonths
required
|
integer
<int32>
Enum:
0
1
2
3
4
5
6
7
8
9
10
11
12
13
18
24
36
Number of months that MongoDB Cloud must keep monthly snapshots. Set
this value to |
|
pointInTimeWindowHours
required
|
integer
<int32>
Number of hours before the current time from which MongoDB Cloud can create a Continuous Cloud Backup snapshot. |
|
snapshotIntervalHours
required
|
integer
<int32>
Enum:
6
8
12
24
Number of hours that must elapse before taking another snapshot. |
|
snapshotRetentionDays
required
|
integer
<int32>
Enum:
2
3
4
5
Number of days that MongoDB Cloud must keep recent snapshots. |
|
weeklySnapshotRetentionWeeks
required
|
integer
<int32>
Enum:
0
1
2
3
4
5
6
7
8
12
16
20
24
52
Number of weeks that MongoDB Cloud must keep weekly snapshots. Set
this value to |
{
-
"clusterCheckpointIntervalMin": 15,
-
"clusterId":
"5faec72692cee15b51eb22a4",
-
"dailySnapshotRetentionDays": 0,
-
"monthlySnapshotRetentionMonths": 0,
-
"pointInTimeWindowHours": 0,
-
"snapshotIntervalHours": 6,
-
"snapshotRetentionDays": 2,
-
"weeklySnapshotRetentionWeeks": 0
}
{
-
"clusterCheckpointIntervalMin": 15,
-
"clusterId":
"5faec72692cee15b51eb22a4",
-
"dailySnapshotRetentionDays": 0,
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"links":
[
-
],
-
"monthlySnapshotRetentionMonths": 0,
-
"pointInTimeWindowHours": 0,
-
"snapshotIntervalHours": 6,
-
"snapshotRetentionDays": 2,
-
"weeklySnapshotRetentionWeeks": 0
}
Returns all legacy backup snapshots for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"clusterId":
"5faec72692cee15b51eb22a4",
-
"complete": true,
-
"created":
{
-
"date":
"2019-08-24T14:15:22Z",
-
"increment":
1199145600
},
-
"doNotDelete": true,
-
"expires":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"78e18e587716102f711a5bca",
-
"lastOplogAppliedTimestamp":
{
-
"date":
"2019-08-24T14:15:22Z",
-
"increment":
1199145600
},
-
"links":
[
-
],
-
"parts":
[
-
{
-
"clusterId":
"5faec72692cee15b51eb22a4",
-
"compressionSetting":
"NONE",
-
"dataSizeBytes":
0,
-
"encryptionEnabled":
true,
-
"fileSizeBytes":
0,
-
"masterKeyUUID":
"72659f08-8b3c-4913-bb4e-a8a68e036502",
-
"mongodVersion":
"string",
-
"replicaSetName":
"string",
-
"storageSizeBytes":
0,
-
"typeName":
"REPLICA_SET"
}
]
}
],
-
"totalCount":
0
}
Removes one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
|
snapshotId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the desired snapshot. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
|
snapshotId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the desired snapshot. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"clusterId":
"5faec72692cee15b51eb22a4",
-
"complete":
true,
-
"created":
{
-
"date":
"2019-08-24T14:15:22Z",
-
"increment": 1199145600
},
-
"doNotDelete":
true,
-
"expires":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"78e18e587716102f711a5bca",
-
"lastOplogAppliedTimestamp": {
-
"date":
"2019-08-24T14:15:22Z",
-
"increment": 1199145600
},
-
"links":
[
-
],
-
"parts":
[
-
{
-
"clusterId":
"5faec72692cee15b51eb22a4",
-
"compressionSetting":
"NONE",
-
"dataSizeBytes": 0,
-
"encryptionEnabled": true,
-
"fileSizeBytes": 0,
-
"masterKeyUUID":
"72659f08-8b3c-4913-bb4e-a8a68e036502",
-
"mongodVersion":
"string",
-
"replicaSetName":
"string",
-
"storageSizeBytes": 0,
-
"typeName":
"REPLICA_SET"
}
]
}
Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
|
snapshotId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the desired snapshot. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Changes One Legacy Backup Snapshot Expiration.
| doNotDelete |
boolean
Flag that indicates whether someone can delete this snapshot. You
can't set |
| expires |
string
<date-time>
Date and time when MongoDB Cloud deletes the snapshot. If
|
{
-
"doNotDelete":
true,
-
"expires":
"2019-08-24T14:15:22Z"
}
{
-
"clusterId":
"5faec72692cee15b51eb22a4",
-
"complete":
true,
-
"created":
{
-
"date":
"2019-08-24T14:15:22Z",
-
"increment": 1199145600
},
-
"doNotDelete":
true,
-
"expires":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"78e18e587716102f711a5bca",
-
"lastOplogAppliedTimestamp": {
-
"date":
"2019-08-24T14:15:22Z",
-
"increment": 1199145600
},
-
"links":
[
-
],
-
"parts":
[
-
{
-
"clusterId":
"5faec72692cee15b51eb22a4",
-
"compressionSetting":
"NONE",
-
"dataSizeBytes": 0,
-
"encryptionEnabled": true,
-
"fileSizeBytes": 0,
-
"masterKeyUUID":
"72659f08-8b3c-4913-bb4e-a8a68e036502",
-
"mongodVersion":
"string",
-
"replicaSetName":
"string",
-
"storageSizeBytes": 0,
-
"typeName":
"REPLICA_SET"
}
]
}
Resets the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role.This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Read Only role.This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"autoDeferOnceEnabled": true,
-
"dayOfWeek":
1,
-
"hourOfDay":
23,
-
"startASAP":
true
}
Updates the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role.This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
Updates the maintenance window for the specified project.
| autoDeferOnceEnabled |
boolean
Flag that indicates whether MongoDB Cloud should defer all maintenance windows for one week after you enable them. |
||||||||||||||||
|
dayOfWeek
required
|
integer
<int32>
[ 1 .. 7 ]
One-based integer that represents the day of the week that the maintenance window starts.
|
||||||||||||||||
|
hourOfDay
required
|
integer
<int32>
[ 0 .. 23 ]
Zero-based integer that represents the hour of the of the day that
the maintenance window starts according to a 24-hour clock. Use
|
||||||||||||||||
| startASAP |
boolean
Flag that indicates whether MongoDB Cloud starts the maintenance
window immediately upon receiving this request. To start the
maintenance window immediately for your project, MongoDB Cloud must
have maintenance scheduled and you must set a maintenance window.
This flag resets to |
{
-
"autoDeferOnceEnabled": true,
-
"dayOfWeek":
1,
-
"hourOfDay":
23,
-
"startASAP":
true
}
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Toggles automatic deferral of the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Defers the maintenance window for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role.This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Creates one MongoDB Cloud user account. A MongoDB Cloud user account only grants access to the MongoDB Cloud application. To grant database access, create a database user. To use this resource, the requesting API Key can have any role. This resource doesn't require the API Key to have an Access List.
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
MongoDB Cloud user account to create.
|
country
required
|
string^([A-Z]{2})$
Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format. |
|
emailAddress
required
|
string
<email>
Email address that belongs to the MongoDB Cloud user. |
|
firstName
required
|
string
First or given name that belongs to the MongoDB Cloud user. |
|
lastName
required
|
string
Last name, family name, or surname that belongs to the MongoDB Cloud user. |
|
mobileNumber
required
|
string(?:(?:\\+?1\\s*(?:[.-]\\s*)?)?(?:(\\s*([2-9]1...
Mobile phone number that belongs to the MongoDB Cloud user. |
|
password
required
|
string
>= 8 characters
Password applied with the username to log in to MongoDB Cloud. MongoDB Cloud does not return this parameter except in response to creating a new MongoDB Cloud user. Only the MongoDB Cloud user can update their password after it has been set from the MongoDB Cloud console. |
|
Array of objects
(Role Assignment)
List of objects that display the MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. A role can apply to one organization or one project but not both. |
|
|
username
required
|
string
<email>
Email address that represents the username of the MongoDB Cloud user. |
{
-
"country":
"string",
-
"emailAddress":
"user@example.com",
-
"firstName":
"string",
-
"lastName":
"string",
-
"mobileNumber":
"string",
-
"password":
"stringst",
-
"roles":
[
-
{
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"orgId":
"4888442a3354817a7320eb61",
-
"roleName":
"ORG_OWNER"
}
],
-
"username":
"user@example.com"
}
{
-
"country":
"string",
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"emailAddress":
"user@example.com",
-
"firstName":
"string",
-
"id":
"887821d389de9fe084df2bdf",
-
"lastAuth":
"2019-08-24T14:15:22Z",
-
"lastName":
"string",
-
"links":
[
-
],
-
"mobileNumber":
"string",
-
"password":
"stringst",
-
"roles":
[
-
{
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"orgId":
"4888442a3354817a7320eb61",
-
"roleName":
"ORG_OWNER"
}
],
-
"teamIds":
[
-
"e254e4ade2206f4520d4107d"
],
-
"username":
"user@example.com"
}
Returns the details for one MongoDB Cloud user account with the specified username. To use this resource, the requesting API Key can have any role. This resource doesn't require the API Key to have an Access List.
|
userName
required
|
string^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%...
Email address that belongs to the MongoDB Cloud user account. You cannot modify this address after creating the user. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"country":
"string",
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"emailAddress":
"user@example.com",
-
"firstName":
"string",
-
"id":
"887821d389de9fe084df2bdf",
-
"lastAuth":
"2019-08-24T14:15:22Z",
-
"lastName":
"string",
-
"links":
[
-
],
-
"mobileNumber":
"string",
-
"password":
"stringst",
-
"roles":
[
-
{
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"orgId":
"4888442a3354817a7320eb61",
-
"roleName":
"ORG_OWNER"
}
],
-
"teamIds":
[
-
"e254e4ade2206f4520d4107d"
],
-
"username":
"user@example.com"
}
Returns the details for one MongoDB Cloud user account with the specified unique identifier for the user. To use this resource, the requesting API Key can have any role. This resource doesn't require the API Key to have an Access List.
|
userId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies this user. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"country":
"string",
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"emailAddress":
"user@example.com",
-
"firstName":
"string",
-
"id":
"887821d389de9fe084df2bdf",
-
"lastAuth":
"2019-08-24T14:15:22Z",
-
"lastName":
"string",
-
"links":
[
-
],
-
"mobileNumber":
"string",
-
"password":
"stringst",
-
"roles":
[
-
{
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"orgId":
"4888442a3354817a7320eb61",
-
"roleName":
"ORG_OWNER"
}
],
-
"teamIds":
[
-
"e254e4ade2206f4520d4107d"
],
-
"username":
"user@example.com"
}
Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin or Project Data Access Read Write roles. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
hostName
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Human-readable label that identifies the host that stores the log files that you want to download. |
|
logName
required
|
string
Enum:
"mongodb"
"mongos"
"mongodb-audit-log"
"mongos-audit-log"
Human-readable label that identifies the log file that you want to return. To return audit logs, enable Database Auditing for the specified project. |
| endDate |
integer
<int64>
>= 1199145600
Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch. |
| startDate |
integer
<int64>
>= 1199145600
Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Return all Atlas Search metric types available for one process in the specified project.
|
processId
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example:
my.host.name.com:27017
Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests. |
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"hardwareMetrics": [
-
{
-
"metricName":
"INDEX_SIZE_ON_DISK",
-
"units":
"BYTES"
}
],
-
"indexMetrics":
[
-
{
-
"metricName":
"INDEX_SIZE_ON_DISK",
-
"units":
"BYTES"
}
],
-
"links":
[
-
],
-
"processId":
"mongodb.example.com:27017",
-
"statusMetrics":
[
-
{
-
"metricName":
"INDEX_SIZE_ON_DISK",
-
"units":
"BYTES"
}
]
}
Returns the Atlas Search index metrics within the specified time range for one namespace in the specified process.
|
processId
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example:
my.host.name.com:27017
Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests. |
|
databaseName
required
|
string
Example:
mydb
Human-readable label that identifies the database. |
|
collectionName
required
|
string
Example:
mycoll
Human-readable label that identifies the collection. |
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
granularity
required
|
string
Example:
granularity=PT1M
Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. |
| period |
string
Example:
period=PT10H
Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end. |
| start |
string
<date-time>
Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period. |
| end |
string
<date-time>
Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
|
metrics
required
|
Array of strings
<= 10 items
unique
Items
Enum:
"INDEX_SIZE_ON_DISK"
"NUMBER_OF_DELETES"
"NUMBER_OF_ERROR_QUERIES"
"NUMBER_OF_GETMORE_COMMANDS"
"NUMBER_OF_INDEX_FIELDS"
"NUMBER_OF_INSERTS"
"NUMBER_OF_SUCCESS_QUERIES"
"NUMBER_OF_UPDATES"
"REPLICATION_LAG"
"TOTAL_NUMBER_OF_QUERIES"
List that contains the measurements that MongoDB Atlas reports for the associated data series. |
{
-
"collectionName":
"string",
-
"databaseName":
"string",
-
"end":
"2019-08-24T14:15:22Z",
-
"granularity":
"PT1M",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"indexIds":
[
-
"2dc22bf163e2f83527cc3838"
],
-
"indexStatsMeasurements": [
-
{
-
"dataPoints":
[
-
{
-
"timestamp":
"2019-08-24T14:15:22Z",
-
"value":
0
}
],
-
"name":
"string",
-
"units":
"BYTES"
}
],
-
"links":
[
-
],
-
"processId":
"mongodb.example.com:27017",
-
"start":
"2019-08-24T14:15:22Z"
}
Returns the Atlas Search metrics data series within the provided time range for one namespace and index name on the specified process.
|
processId
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example:
my.host.name.com:27017
Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests. |
|
indexName
required
|
string
Example:
myindex
Human-readable label that identifies the index. |
|
databaseName
required
|
string
Example:
mydb
Human-readable label that identifies the database. |
|
collectionName
required
|
string
Example:
mycoll
Human-readable label that identifies the collection. |
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
granularity
required
|
string
Example:
granularity=PT1M
Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. |
| period |
string
Example:
period=PT10H
Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end. |
| start |
string
<date-time>
Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period. |
| end |
string
<date-time>
Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
|
metrics
required
|
Array of strings
<= 10 items
unique
Items
Enum:
"INDEX_SIZE_ON_DISK"
"NUMBER_OF_DELETES"
"NUMBER_OF_ERROR_QUERIES"
"NUMBER_OF_GETMORE_COMMANDS"
"NUMBER_OF_INDEX_FIELDS"
"NUMBER_OF_INSERTS"
"NUMBER_OF_SUCCESS_QUERIES"
"NUMBER_OF_UPDATES"
"REPLICATION_LAG"
"TOTAL_NUMBER_OF_QUERIES"
List that contains the measurements that MongoDB Atlas reports for the associated data series. |
{
-
"collectionName":
"string",
-
"databaseName":
"string",
-
"end":
"2019-08-24T14:15:22Z",
-
"granularity":
"PT1M",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"indexIds":
[
-
"2dc22bf163e2f83527cc3838"
],
-
"indexStatsMeasurements": [
-
{
-
"dataPoints":
[
-
{
-
"timestamp":
"2019-08-24T14:15:22Z",
-
"value":
0
}
],
-
"name":
"string",
-
"units":
"BYTES"
}
],
-
"links":
[
-
],
-
"processId":
"mongodb.example.com:27017",
-
"start":
"2019-08-24T14:15:22Z"
}
Returns the Atlas Search hardware and status data series within the provided time range for one process in the specified project.
|
processId
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example:
my.host.name.com:27017
Combination of hostname and IANA port that serves the MongoDB process. The host must be the hostname, fully qualified domain name (FQDN), or Internet Protocol address (IPv4 or IPv6) of the host that runs the MongoDB process (mongod or mongos). The port must be the IANA port on which the MongoDB process listens for requests. |
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
granularity
required
|
string
Example:
granularity=PT1M
Duration that specifies the interval at which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. |
| period |
string
Example:
period=PT10H
Duration over which Atlas reports the metrics. This parameter expresses its value in the ISO 8601 duration format in UTC. Include this parameter when you do not set start and end. |
| start |
string
<date-time>
Date and time when MongoDB Cloud begins reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period. |
| end |
string
<date-time>
Date and time when MongoDB Cloud stops reporting the metrics. This parameter expresses its value in the ISO 8601 timestamp format in UTC. Include this parameter when you do not set period. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
|
metrics
required
|
Array of strings
<= 10 items
unique
Items
Enum:
"FTS_DISK_USAGE"
"FTS_PROCESS_CPU_KERNEL"
"FTS_PROCESS_CPU_USER"
"FTS_PROCESS_NORMALIZED_CPU_KERNEL"
"FTS_PROCESS_NORMALIZED_CPU_USER"
"FTS_PROCESS_RESIDENT_MEMORY"
"FTS_PROCESS_SHARED_MEMORY"
"FTS_PROCESS_VIRTUAL_MEMORY"
"JVM_CURRENT_MEMORY"
"JVM_MAX_MEMORY"
List that contains the metrics that you want MongoDB Atlas to report for the associated data series. If you don't set this parameter, this resource returns all hardware and status metrics for the associated data series. |
{
-
"end":
"2019-08-24T14:15:22Z",
-
"granularity":
"PT1M",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"hardwareMeasurements": [
-
{
-
"dataPoints":
[
-
{
-
"timestamp":
"2019-08-24T14:15:22Z",
-
"value":
0
}
],
-
"name":
"string",
-
"units":
"BYTES"
}
],
-
"links":
[
-
],
-
"processId":
"mongodb.example.com:27017",
-
"start":
"2019-08-24T14:15:22Z",
-
"statusMeasurements": [
-
{
-
"dataPoints":
[
-
{
-
"timestamp":
"2019-08-24T14:15:22Z",
-
"value":
0
}
],
-
"name":
"string",
-
"units":
"BYTES"
}
]
}
Returns details of all processes for the specified project. A MongoDB process
can be either a mongod or mongos. To use this
resource, the requesting API Key must have the Project Read Only role. This
resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"created":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"hostname":
"string",
-
"id":
"string",
-
"lastPing":
"2019-08-24T14:15:22Z",
-
"links":
[
-
],
-
"port": 0,
-
"replicaSetName":
"string",
-
"typeName":
"REPLICA_PRIMARY",
-
"userAlias":
"string",
-
"version":
"string"
}
],
-
"totalCount":
0
}
Returns the processes for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
processId
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example:
mongodb.example.com:27017
Combination of hostname and Internet Assigned Numbers Authority
(IANA) port that serves the MongoDB process. The host must be the
hostname, fully qualified domain name (FQDN), or Internet Protocol
address (IPv4 or IPv6) of the host that runs the MongoDB process
( |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"created":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"hostname":
"string",
-
"id":
"string",
-
"lastPing":
"2019-08-24T14:15:22Z",
-
"links":
[
-
],
-
"port":
0,
-
"replicaSetName":
"string",
-
"typeName":
"REPLICA_PRIMARY",
-
"userAlias":
"string",
-
"version":
"string"
}
Returns the list of databases running on the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
processId
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example:
mongodb.example.com:27017
Combination of hostname and Internet Assigned Numbers Authority
(IANA) port that serves the MongoDB process. The host must be the
hostname, fully qualified domain name (FQDN), or Internet Protocol
address (IPv4 or IPv6) of the host that runs the MongoDB process
( |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"databaseName":
"string",
-
"links":
[
-
]
}
],
-
"totalCount":
0
}
Returns one database running on the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
databaseName
required
|
string
Human-readable label that identifies the database that the specified MongoDB process serves. |
|
processId
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example:
mongodb.example.com:27017
Combination of hostname and Internet Assigned Numbers Authority
(IANA) port that serves the MongoDB process. The host must be the
hostname, fully qualified domain name (FQDN), or Internet Protocol
address (IPv4 or IPv6) of the host that runs the MongoDB process
( |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"databaseName":
"string",
-
"links":
[
-
]
}
Returns the measurements of one database for the specified host for the
specified project. Returns the database's on-disk storage space based on
the MongoDB dbStats command output. To use this resource, the
requesting API Key must have the Project Read Only role. This resource
doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
databaseName
required
|
string
Human-readable label that identifies the database that the specified MongoDB process serves. |
|
processId
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example:
mongodb.example.com:27017
Combination of hostname and Internet Assigned Numbers Authority
(IANA) port that serves the MongoDB process. The host must be the
hostname, fully qualified domain name (FQDN), or Internet Protocol
address (IPv4 or IPv6) of the host that runs the MongoDB process
( |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| m |
Array of strings
[ 1 .. 10 ] items
unique
Items
Enum:
"DATABASE_AVERAGE_OBJECT_SIZE"
"DATABASE_COLLECTION_COUNT"
"DATABASE_DATA_SIZE"
"DATABASE_STORAGE_SIZE"
"DATABASE_INDEX_SIZE"
"DATABASE_INDEX_COUNT"
"DATABASE_EXTENT_COUNT"
"DATABASE_OBJECT_COUNT"
"DATABASE_VIEW_COUNT"
One or more types of measurement to request for this MongoDB
process. If omitted, the resource returns all measurements. To
specify multiple values for |
{
-
"databaseName":
"string",
-
"end":
"2019-08-24T14:15:22Z",
-
"granularity":
"PT1M",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"hostId":
"mongodb.example.com:27017",
-
"links":
[
-
],
-
"measurements":
[
-
{
-
"dataPoints":
[
-
{
-
"timestamp":
"2019-08-24T14:15:22Z",
-
"value":
0
}
],
-
"name":
"string",
-
"units":
"BYTES"
}
],
-
"partitionName":
"string",
-
"processId":
"mongodb.example.com:27017",
-
"start":
"2019-08-24T14:15:22Z"
}
Returns the list of disks or partitions for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
processId
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example:
mongodb.example.com:27017
Combination of hostname and Internet Assigned Numbers Authority
(IANA) port that serves the MongoDB process. The host must be the
hostname, fully qualified domain name (FQDN), or Internet Protocol
address (IPv4 or IPv6) of the host that runs the MongoDB process
( |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"links":
[
-
],
-
"partitionName":
"string"
}
],
-
"totalCount":
0
}
Returns the measurements of one disk or partition for the specified host for the specified project. Returned value can be one of the following:
To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
partitionName
required
|
string
Human-readable label of the disk or partition to which the measurements apply. |
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
processId
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example:
mongodb.example.com:27017
Combination of hostname and Internet Assigned Numbers Authority
(IANA) port that serves the MongoDB process. The host must be the
hostname, fully qualified domain name (FQDN), or Internet Protocol
address (IPv4 or IPv6) of the host that runs the MongoDB process
( |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"links":
[
-
],
-
"partitionName":
"string"
}
Returns the measurements of one disk or partition for the specified host for the specified project. Returned value can be one of the following:
To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
partitionName
required
|
string
Human-readable label of the disk or partition to which the measurements apply. |
|
processId
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example:
mongodb.example.com:27017
Combination of hostname and Internet Assigned Numbers Authority
(IANA) port that serves the MongoDB process. The host must be the
hostname, fully qualified domain name (FQDN), or Internet Protocol
address (IPv4 or IPv6) of the host that runs the MongoDB process
( |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| m |
Array of strings
[ 1 .. 10 ] items
unique
Items
Enum:
"DISK_PARTITION_IOPS_READ"
"MAX_DISK_PARTITION_IOPS_READ"
"DISK_PARTITION_IOPS_WRITE"
"MAX_DISK_PARTITION_IOPS_WRITE"
"DISK_PARTITION_IOPS_TOTAL"
"MAX_DISK_PARTITION_IOPS_TOTAL"
"DISK_PARTITION_UTILIZATION"
"MAX_DISK_PARTITION_UTILIZATION"
"DISK_PARTITION_LATENCY_READ"
"MAX_DISK_PARTITION_LATENCY_READ"
"DISK_PARTITION_LATENCY_WRITE"
"MAX_DISK_PARTITION_LATENCY_WRITE"
"DISK_PARTITION_SPACE_FREE"
"MAX_DISK_PARTITION_SPACE_FREE"
"DISK_PARTITION_SPACE_USED"
"MAX_DISK_PARTITION_SPACE_USED"
"DISK_PARTITION_SPACE_PERCENT_FREE"
"MAX_DISK_PARTITION_SPACE_PERCENT_FREE"
"DISK_PARTITION_SPACE_PERCENT_USED"
"MAX_DISK_PARTITION_SPACE_PERCENT_USED"
One or more types of measurement to request for this MongoDB
process. If omitted, the resource returns all measurements. To
specify multiple values for |
{
-
"databaseName":
"string",
-
"end":
"2019-08-24T14:15:22Z",
-
"granularity":
"PT1M",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"hostId":
"mongodb.example.com:27017",
-
"links":
[
-
],
-
"measurements":
[
-
{
-
"dataPoints":
[
-
{
-
"timestamp":
"2019-08-24T14:15:22Z",
-
"value":
0
}
],
-
"name":
"string",
-
"units":
"BYTES"
}
],
-
"partitionName":
"string",
-
"processId":
"mongodb.example.com:27017",
-
"start":
"2019-08-24T14:15:22Z"
}
Returns measurements of the disk or partition per process for the specified host for the specified project. Returned value can be one of the following:
To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
processId
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Example:
mongodb.example.com:27017
Combination of hostname and Internet Assigned Numbers Authority
(IANA) port that serves the MongoDB process. The host must be the
hostname, fully qualified domain name (FQDN), or Internet Protocol
address (IPv4 or IPv6) of the host that runs the MongoDB process
( |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| m |
Array of strings
[ 1 .. 10 ] items
unique
Items
Enum:
"ASSERT_MSG"
"ASSERT_REGULAR"
"ASSERT_USER"
"ASSERT_WARNING"
"BACKGROUND_FLUSH_AVG"
"CACHE_BYTES_READ_INTO"
"CACHE_BYTES_WRITTEN_FROM"
"CACHE_DIRTY_BYTES"
"CACHE_USED_BYTES"
"COMPUTED_MEMORY"
"CONNECTIONS"
"CURSORS_TOTAL_OPEN"
"CURSORS_TOTAL_TIMED_OUT"
"DB_DATA_SIZE_TOTAL"
"DB_STORAGE_TOTAL"
"DOCUMENT_METRICS_DELETED"
"DOCUMENT_METRICS_INSERTED"
"DOCUMENT_METRICS_RETURNED"
"DOCUMENT_METRICS_UPDATED"
"EXTRA_INFO_PAGE_FAULTS"
"FTS_DISK_UTILIZATION"
"FTS_MEMORY_MAPPED"
"FTS_MEMORY_RESIDENT"
"FTS_MEMORY_VIRTUAL"
"FTS_PROCESS_CPU_KERNEL"
"FTS_PROCESS_CPU_USER"
"FTS_PROCESS_NORMALIZED_CPU_KERNEL"
"FTS_PROCESS_NORMALIZED_CPU_USER"
"GLOBAL_ACCESSES_NOT_IN_MEMORY"
"GLOBAL_LOCK_CURRENT_QUEUE_READERS"
"GLOBAL_LOCK_CURRENT_QUEUE_TOTAL"
"GLOBAL_LOCK_CURRENT_QUEUE_WRITERS"
"GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN"
"INDEX_COUNTERS_BTREE_ACCESSES"
"INDEX_COUNTERS_BTREE_HITS"
"INDEX_COUNTERS_BTREE_MISS_RATIO"
"INDEX_COUNTERS_BTREE_MISSES"
"JOURNALING_COMMITS_IN_WRITE_LOCK"
"JOURNALING_MB"
"JOURNALING_WRITE_DATA_FILES_MB"
"MAX_PROCESS_CPU_CHILDREN_KERNEL"
"MAX_PROCESS_CPU_CHILDREN_USER"
"MAX_PROCESS_CPU_KERNEL"
"MAX_PROCESS_CPU_USER"
"MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL"
"MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER"
"MAX_PROCESS_NORMALIZED_CPU_KERNEL"
"MAX_PROCESS_NORMALIZED_CPU_USER"
"MAX_SWAP_USAGE_FREE"
"MAX_SWAP_USAGE_USED "
"MAX_SYSTEM_CPU_GUEST"
"MAX_SYSTEM_CPU_IOWAIT"
"MAX_SYSTEM_CPU_IRQ"
"MAX_SYSTEM_CPU_KERNEL"
"MAX_SYSTEM_CPU_SOFTIRQ"
"MAX_SYSTEM_CPU_STEAL"
"MAX_SYSTEM_CPU_USER"
"MAX_SYSTEM_MEMORY_AVAILABLE"
"MAX_SYSTEM_MEMORY_FREE"
"MAX_SYSTEM_MEMORY_USED"
"MAX_SYSTEM_NETWORK_IN"
"MAX_SYSTEM_NETWORK_OUT"
"MAX_SYSTEM_NORMALIZED_CPU_GUEST"
"MAX_SYSTEM_NORMALIZED_CPU_IOWAIT"
"MAX_SYSTEM_NORMALIZED_CPU_IRQ"
"MAX_SYSTEM_NORMALIZED_CPU_KERNEL"
"MAX_SYSTEM_NORMALIZED_CPU_NICE"
"MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ"
"MAX_SYSTEM_NORMALIZED_CPU_STEAL"
"MAX_SYSTEM_NORMALIZED_CPU_USER"
"MEMORY_MAPPED"
"MEMORY_RESIDENT"
"MEMORY_VIRTUAL"
"NETWORK_BYTES_IN"
"NETWORK_BYTES_OUT"
"NETWORK_NUM_REQUESTS"
"OP_EXECUTION_TIME_COMMANDS"
"OP_EXECUTION_TIME_READS"
"OP_EXECUTION_TIME_WRITES"
"OPCOUNTER_CMD"
"OPCOUNTER_DELETE"
"OPCOUNTER_GETMORE"
"OPCOUNTER_INSERT"
"OPCOUNTER_QUERY"
"OPCOUNTER_REPL_CMD"
"OPCOUNTER_REPL_DELETE"
"OPCOUNTER_REPL_INSERT"
"OPCOUNTER_REPL_UPDATE"
"OPCOUNTER_UPDATE"
"OPERATIONS_SCAN_AND_ORDER"
"OPLOG_MASTER_LAG_TIME_DIFF"
"OPLOG_MASTER_TIME"
"OPLOG_RATE_GB_PER_HOUR"
"OPLOG_SLAVE_LAG_MASTER_TIME"
"OPLOG_REPLICATION_LAG"
"PROCESS_CPU_CHILDREN_KERNEL"
"PROCESS_CPU_CHILDREN_USER"
"PROCESS_CPU_KERNEL"
"PROCESS_CPU_USER"
"PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL"
"PROCESS_NORMALIZED_CPU_CHILDREN_USER"
"PROCESS_NORMALIZED_CPU_KERNEL"
"PROCESS_NORMALIZED_CPU_USER"
"QUERY_EXECUTOR_SCANNED"
"QUERY_EXECUTOR_SCANNED_OBJECTS"
"QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED"
"QUERY_TARGETING_SCANNED_PER_RETURNED"
"RESTARTS_IN_LAST_HOUR"
"SWAP_USAGE_FREE"
"SWAP_USAGE_USED"
"SYSTEM_CPU_GUEST"
"SYSTEM_CPU_IOWAIT"
"SYSTEM_CPU_IRQ"
"SYSTEM_CPU_KERNEL"
"SYSTEM_CPU_NICE"
"SYSTEM_CPU_SOFTIRQ"
"SYSTEM_CPU_STEAL"
"SYSTEM_CPU_USER"
"SYSTEM_MEMORY_AVAILABLE"
"SYSTEM_MEMORY_FREE"
"SYSTEM_MEMORY_USED"
"SYSTEM_NETWORK_IN"
"SYSTEM_NETWORK_OUT"
"SYSTEM_NORMALIZED_CPU_GUEST"
"SYSTEM_NORMALIZED_CPU_IOWAIT"
"SYSTEM_NORMALIZED_CPU_IRQ"
"SYSTEM_NORMALIZED_CPU_KERNEL"
"SYSTEM_NORMALIZED_CPU_NICE"
"SYSTEM_NORMALIZED_CPU_SOFTIRQ"
"SYSTEM_NORMALIZED_CPU_STEAL"
"SYSTEM_NORMALIZED_CPU_USER"
"TICKETS_AVAILABLE_READS"
"TICKETS_AVAILABLE_WRITE"
One or more types of measurement to request for this MongoDB
process. If omitted, the resource returns all measurements. To
specify multiple values for |
| period |
string
<date-time>
Date and time that indicates how far in the past to query. You can't set this value with start and end in the same request. This parameter expresses its value in the ISO 8601 duration format in UTC |
{
-
"databaseName":
"string",
-
"end":
"2019-08-24T14:15:22Z",
-
"granularity":
"PT1M",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"hostId":
"mongodb.example.com:27017",
-
"links":
[
-
],
-
"measurements":
[
-
{
-
"dataPoints":
[
-
{
-
"timestamp":
"2019-08-24T14:15:22Z",
-
"value":
0
}
],
-
"name":
"string",
-
"units":
"BYTES"
}
],
-
"partitionName":
"string",
-
"processId":
"mongodb.example.com:27017",
-
"start":
"2019-08-24T14:15:22Z"
}
Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin or Project Data Access Read Write roles. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
hostName
required
|
string
Fully qualified domain name or IP address of the MongoDB host that stores the log files that you want to download. |
|
logName
required
|
string
Enum:
"mongodb"
"mongos"
"mongodb-audit-log"
"mongos-audit-log"
Human-readable label of the log file that you want to return. You can return audit logs only if you enable Database Auditing for the specified project. |
| endDate |
integer
<int64>
>= 1199145600
Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch. |
| startDate |
integer
<int64>
>= 1199145600
Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns the details for all clusters in the specific project to which you have access. Clusters contain a group of hosts that maintain the same data set. The response includes multi-cloud clusters. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"backupEnabled": false,
-
"biConnector":
{
-
"enabled": true,
-
"readPreference":
"PRIMARY"
},
-
"clusterType":
"REPLICASET",
-
"connectionStrings":
{
-
"awsPrivateLink":
{
-
"property1":
"string",
-
"property2":
"string"
},
-
"awsPrivateLinkSrv":
{
-
"property1":
"string",
-
"property2":
"string"
},
-
"private":
"string",
-
"privateEndpoint":
[
-
{
-
"connectionString":
"string",
-
"endpoints":
[
-
{
-
"endpointId":
"string",
-
"providerName":
"AWS",
-
"region":
"string"
}
],
-
"srvConnectionString":
"string",
-
"type":
"MONGOD"
}
],
-
"privateSrv":
"string",
-
"standard":
"string",
-
"standardSrv":
"string"
},
-
"createDate":
"2019-08-24T14:15:22Z",
-
"diskSizeGB": 10,
-
"encryptionAtRestProvider":
"NONE",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"6492cb3770e674ece4e89b41",
-
"labels":
[
-
{
-
"key":
"string",
-
"value":
"string"
}
],
-
"links":
[
-
],
-
"mongoDBMajorVersion":
"4.0",
-
"mongoDBVersion":
"string",
-
"name":
"string",
-
"paused": true,
-
"pitEnabled": true,
-
"replicationSpecs":
[
-
{
-
"id":
"6492cb3770e674ece4e89b41",
-
"numShards":
1,
-
"regionConfigs":
[
-
{
-
"electableSpecs":
{
-
"diskIOPS":
0,
-
"ebsVolumeType":
"STANDARD",
-
"instanceSize":
"M10",
-
"nodeCount":
0
},
-
"priority":
7,
-
"providerName":
"AWS",
-
"regionName":
"US_GOV_WEST_1",
-
"analyticsAutoScaling":
{
-
"compute":
{
-
"enabled":
true,
-
"maxInstanceSize":
"M10",
-
"minInstanceSize":
"M10",
-
"scaleDownEnabled":
true
},
-
"diskGB":
{
-
"enabled":
true
}
},
-
"analyticsSpecs":
{
-
"nodeCount":
0,
-
"diskIOPS":
0,
-
"ebsVolumeType":
"STANDARD",
-
"instanceSize":
"M10"
},
-
"autoScaling":
{
-
"compute":
{
-
"enabled":
true,
-
"maxInstanceSize":
"M10",
-
"minInstanceSize":
"M10",
-
"scaleDownEnabled":
true
},
-
"diskGB":
{
-
"enabled":
true
}
},
-
"readOnlySpecs":
{
-
"nodeCount":
0,
-
"diskIOPS":
0,
-
"ebsVolumeType":
"STANDARD",
-
"instanceSize":
"M10"
}
}
],
-
"zoneName":
"string"
}
],
-
"rootCertType":
"ISRGROOTX1",
-
"stateName":
"IDLE",
-
"terminationProtectionEnabled": false,
-
"versionReleaseSystem":
"LTS"
}
],
-
"totalCount":
0
}
Creates one cluster in the specific project. Clusters contain a group of hosts that maintain the same data set. This resource can create multi-cloud clusters. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Cluster to create in the specific project.
| backupEnabled |
boolean
Default:
false
Flag that indicates whether the cluster can perform backups. If set
to |
|
object
(MongoDB Connector for Business Intelligence Settings)
Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster. |
|
| clusterType |
string
Enum:
"REPLICASET"
"SHARDED"
"GEOSHARDED"
Configuration of nodes that comprise the cluster. |
| diskSizeGB |
number
<double>
[ 10 .. 4096 ]
Storage capacity that the host's root volume possesses expressed in gigabytes. Increase this number to add capacity. MongoDB Cloud requires this parameter if you set replicationSpecs. If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. |
| encryptionAtRestProvider |
string
Enum:
"NONE"
"AWS"
"AZURE"
"GCP"
Cloud service provider that manages your customer keys to provide an
additional layer of encryption at rest for the cluster. To enable
customer key management for encryption at rest, the cluster
replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize
setting must be |
|
Array of objects
(Component Label)
Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels. |
|
| mongoDBMajorVersion |
string
Default:
"5.0"
Enum:
"4.0"
"4.2"
"4.4"
"5.0"
Major MongoDB version of the cluster. MongoDB Cloud deploys the cluster with the latest stable release of the specified version. |
| name |
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the advanced cluster. |
| paused |
boolean
Flag that indicates whether the cluster is paused. |
| pitEnabled |
boolean
Flag that indicates whether the cluster uses continuous cloud backups. |
|
Array of objects
(Replication Specifications)
List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global sharded clusters and replica sets, this array has one object representing where your clusters nodes deploy. |
|
| rootCertType |
string
Default:
"ISRGROOTX1"
Value:
"ISRGROOTX1"
Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group. |
| terminationProtectionEnabled |
boolean
Default:
false
Flag that indicates whether termination protection is enabled on the
cluster. If set to |
| versionReleaseSystem |
string
Default:
"LTS"
Enum:
"LTS"
"CONTINUOUS"
Method by which the cluster maintains the MongoDB versions. If value
is |
Multi Cloud Cluster
{
-
"name":
"multiCloud",
-
"clusterType":
"REPLICASET",
-
"replicationSpecs": [
-
{
-
"numShards": 1,
-
"regionConfigs":
[
-
{
-
"analyticsAutoScaling":
{
-
"autoIndexing":
{
-
"enabled":
false
},
-
"compute":
{
-
"enabled":
true,
-
"maxInstanceSize":
"M40",
-
"minInstanceSize":
"M30",
-
"scaleDownEnabled":
true
},
-
"diskGB":
{
-
"enabled":
true
}
},
-
"analyticsSpecs":
{
-
"instanceSize":
"M30",
-
"nodeCount":
0
},
-
"autoScaling":
{
-
"autoIndexing":
{
-
"enabled":
false
},
-
"compute":
{
-
"enabled":
true,
-
"maxInstanceSize":
"M40",
-
"minInstanceSize":
"M30",
-
"scaleDownEnabled":
true
},
-
"diskGB":
{
-
"enabled":
true
}
},
-
"providerName":
"AWS",
-
"electableSpecs":
{
-
"instanceSize":
"M30",
-
"nodeCount":
3
},
-
"hiddenSecondarySpecs":
{
-
"instanceSize":
"M30",
-
"nodeCount":
0
},
-
"priority":
7,
-
"readOnlySpecs":
{
-
"instanceSize":
"M30",
-
"nodeCount":
0
},
-
"regionName":
"US_EAST_1"
},
-
{
-
"analyticsAutoScaling":
{
-
"autoIndexing":
{
-
"enabled":
false
},
-
"compute":
{
-
"enabled":
true,
-
"maxInstanceSize":
"M40",
-
"minInstanceSize":
"M30",
-
"scaleDownEnabled":
true
},
-
"diskGB":
{
-
"enabled":
true
}
},
-
"analyticsSpecs":
{
-
"instanceSize":
"M30",
-
"nodeCount":
0
},
-
"autoScaling":
{
-
"autoIndexing":
{
-
"enabled":
false
},
-
"compute":
{
-
"enabled":
true,
-
"maxInstanceSize":
"M40",
-
"minInstanceSize":
"M30",
-
"scaleDownEnabled":
true
},
-
"diskGB":
{
-
"enabled":
true
}
},
-
"providerName":
"GCP",
-
"electableSpecs":
{
-
"instanceSize":
"M30",
-
"nodeCount":
2
},
-
"hiddenSecondarySpecs":
{
-
"instanceSize":
"M30",
-
"nodeCount":
0
},
-
"priority":
6,
-
"readOnlySpecs":
{
-
"instanceSize":
"M30",
-
"nodeCount":
0
},
-
"regionName":
"EASTERN_US"
}
],
-
"zoneName":
"Zone 1"
}
],
-
"links":
[ ]
}
{
-
"backupEnabled":
false,
-
"biConnector":
{
-
"enabled":
true,
-
"readPreference":
"PRIMARY"
},
-
"clusterType":
"REPLICASET",
-
"connectionStrings": {
-
"awsPrivateLink":
{
-
"property1":
"string",
-
"property2":
"string"
},
-
"awsPrivateLinkSrv":
{
-
"property1":
"string",
-
"property2":
"string"
},
-
"private":
"string",
-
"privateEndpoint":
[
-
{
-
"connectionString":
"string",
-
"endpoints":
[
-
{
-
"endpointId":
"string",
-
"providerName":
"AWS",
-
"region":
"string"
}
],
-
"srvConnectionString":
"string",
-
"type":
"MONGOD"
}
],
-
"privateSrv": "string",
-
"standard":
"string",
-
"standardSrv":
"string"
},
-
"createDate":
"2019-08-24T14:15:22Z",
-
"diskSizeGB":
10,
-
"encryptionAtRestProvider": "NONE",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"6492cb3770e674ece4e89b41",
-
"labels":
[
-
{
-
"key":
"string",
-
"value":
"string"
}
],
-
"links":
[
-
],
-
"mongoDBMajorVersion": "4.0",
-
"mongoDBVersion":
"string",
-
"name":
"string",
-
"paused":
true,
-
"pitEnabled":
true,
-
"replicationSpecs": [
-
{
-
"id":
"6492cb3770e674ece4e89b41",
-
"numShards": 1,
-
"regionConfigs":
[
-
{
-
"electableSpecs":
{
-
"diskIOPS":
0,
-
"ebsVolumeType":
"STANDARD",
-
"instanceSize":
"M10",
-
"nodeCount":
0
},
-
"priority":
7,
-
"providerName":
"AWS",
-
"regionName":
"US_GOV_WEST_1",
-
"analyticsAutoScaling":
{
-
"compute":
{
-
"enabled":
true,
-
"maxInstanceSize":
"M10",
-
"minInstanceSize":
"M10",
-
"scaleDownEnabled":
true
},
-
"diskGB":
{
-
"enabled":
true
}
},
-
"analyticsSpecs":
{
-
"nodeCount":
0,
-
"diskIOPS":
0,
-
"ebsVolumeType":
"STANDARD",
-
"instanceSize":
"M10"
},
-
"autoScaling":
{
-
"compute":
{
-
"enabled":
true,
-
"maxInstanceSize":
"M10",
-
"minInstanceSize":
"M10",
-
"scaleDownEnabled":
true
},
-
"diskGB":
{
-
"enabled":
true
}
},
-
"readOnlySpecs":
{
-
"nodeCount":
0,
-
"diskIOPS":
0,
-
"ebsVolumeType":
"STANDARD",
-
"instanceSize":
"M10"
}
}
],
-
"zoneName":
"string"
}
],
-
"rootCertType":
"ISRGROOTX1",
-
"stateName":
"IDLE",
-
"terminationProtectionEnabled": false,
-
"versionReleaseSystem": "LTS"
}
Removes one cluster with advanced features from the specified project. The cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. The response includes multi-cloud clusters. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies this advanced cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"backupEnabled":
false,
-
"biConnector":
{
-
"enabled":
true,
-
"readPreference":
"PRIMARY"
},
-
"clusterType":
"REPLICASET",
-
"connectionStrings": {
-
"awsPrivateLink":
{
-
"property1":
"string",
-
"property2":
"string"
},
-
"awsPrivateLinkSrv":
{
-
"property1":
"string",
-
"property2":
"string"
},
-
"private":
"string",
-
"privateEndpoint":
[
-
{
-
"connectionString":
"string",
-
"endpoints":
[
-
{
-
"endpointId":
"string",
-
"providerName":
"AWS",
-
"region":
"string"
}
],
-
"srvConnectionString":
"string",
-
"type":
"MONGOD"
}
],
-
"privateSrv": "string",
-
"standard":
"string",
-
"standardSrv":
"string"
},
-
"createDate":
"2019-08-24T14:15:22Z",
-
"diskSizeGB":
10,
-
"encryptionAtRestProvider": "NONE",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"6492cb3770e674ece4e89b41",
-
"labels":
[
-
{
-
"key":
"string",
-
"value":
"string"
}
],
-
"links":
[
-
],
-
"mongoDBMajorVersion": "4.0",
-
"mongoDBVersion":
"string",
-
"name":
"string",
-
"paused":
true,
-
"pitEnabled":
true,
-
"replicationSpecs": [
-
{
-
"id":
"6492cb3770e674ece4e89b41",
-
"numShards": 1,
-
"regionConfigs":
[
-
{
-
"electableSpecs":
{
-
"diskIOPS":
0,
-
"ebsVolumeType":
"STANDARD",
-
"instanceSize":
"M10",
-
"nodeCount":
0
},
-
"priority":
7,
-
"providerName":
"AWS",
-
"regionName":
"US_GOV_WEST_1",
-
"analyticsAutoScaling":
{
-
"compute":
{
-
"enabled":
true,
-
"maxInstanceSize":
"M10",
-
"minInstanceSize":
"M10",
-
"scaleDownEnabled":
true
},
-
"diskGB":
{
-
"enabled":
true
}
},
-
"analyticsSpecs":
{
-
"nodeCount":
0,
-
"diskIOPS":
0,
-
"ebsVolumeType":
"STANDARD",
-
"instanceSize":
"M10"
},
-
"autoScaling":
{
-
"compute":
{
-
"enabled":
true,
-
"maxInstanceSize":
"M10",
-
"minInstanceSize":
"M10",
-
"scaleDownEnabled":
true
},
-
"diskGB":
{
-
"enabled":
true
}
},
-
"readOnlySpecs":
{
-
"nodeCount":
0,
-
"diskIOPS":
0,
-
"ebsVolumeType":
"STANDARD",
-
"instanceSize":
"M10"
}
}
],
-
"zoneName":
"string"
}
],
-
"rootCertType":
"ISRGROOTX1",
-
"stateName":
"IDLE",
-
"terminationProtectionEnabled": false,
-
"versionReleaseSystem": "LTS"
}
Updates the details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. This resource can update multi-cloud clusters. To update a cluster's termination protection, the requesting API Key must have the Project Owner role. For all other updates, the requesting API Key must have the Project Cluster Manager role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the advanced cluster to modify. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Cluster to update in the specified project.
| backupEnabled |
boolean
Default:
false
Flag that indicates whether the cluster can perform backups. If set
to |
|
object
(MongoDB Connector for Business Intelligence Settings)
Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster. |
|
| clusterType |
string
Enum:
"REPLICASET"
"SHARDED"
"GEOSHARDED"
Configuration of nodes that comprise the cluster. |
| diskSizeGB |
number
<double>
[ 10 .. 4096 ]
Storage capacity that the host's root volume possesses expressed in gigabytes. Increase this number to add capacity. MongoDB Cloud requires this parameter if you set replicationSpecs. If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. Storage charge calculations depend on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier. |
| encryptionAtRestProvider |
string
Enum:
"NONE"
"AWS"
"AZURE"
"GCP"
Cloud service provider that manages your customer keys to provide an
additional layer of encryption at rest for the cluster. To enable
customer key management for encryption at rest, the cluster
replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize
setting must be |
|
Array of objects
(Component Label)
Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels. |
|
| mongoDBMajorVersion |
string
Default:
"5.0"
Enum:
"4.0"
"4.2"
"4.4"
"5.0"
Major MongoDB version of the cluster. MongoDB Cloud deploys the cluster with the latest stable release of the specified version. |
| name |
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the advanced cluster. |
| paused |
boolean
Flag that indicates whether the cluster is paused. |
| pitEnabled |
boolean
Flag that indicates whether the cluster uses continuous cloud backups. |
|
Array of objects
(Replication Specifications)
List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global sharded clusters and replica sets, this array has one object representing where your clusters nodes deploy. |
|
| rootCertType |
string
Default:
"ISRGROOTX1"
Value:
"ISRGROOTX1"
Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group. |
| terminationProtectionEnabled |
boolean
Default:
false
Flag that indicates whether termination protection is enabled on the
cluster. If set to |
| versionReleaseSystem |
string
Default:
"LTS"
Enum:
"LTS"
"CONTINUOUS"
Method by which the cluster maintains the MongoDB versions. If value
is |
{
-
"backupEnabled":
false,
-
"biConnector":
{
-
"enabled":
true,
-
"readPreference":
"PRIMARY"
},
-
"clusterType":
"REPLICASET",
-
"diskSizeGB":
10,
-
"encryptionAtRestProvider": "NONE",
-
"labels":
[
-
{
-
"key":
"string",
-
"value":
"string"
}
],
-
"mongoDBMajorVersion": "4.0",
-
"name":
"string",
-
"paused":
true,
-
"pitEnabled":
true,
-
"replicationSpecs": [
-
{
-
"numShards": 1,
-
"regionConfigs":
[
-
{
-
"electableSpecs":
{
-
"diskIOPS":
0,
-
"ebsVolumeType":
"STANDARD",
-
"instanceSize":
"M10",
-
"nodeCount":
0
},
-
"priority":
7,
-
"providerName":
"AWS",
-
"regionName":
"US_GOV_WEST_1",
-
"analyticsAutoScaling":
{
-
"compute":
{
-
"enabled":
true,
-
"maxInstanceSize":
"M10",
-
"minInstanceSize":
"M10",
-
"scaleDownEnabled":
true
},
-
"diskGB":
{
-
"enabled":
true
}
},
-
"analyticsSpecs":
{
-
"nodeCount":
0,
-
"diskIOPS":
0,
-
"ebsVolumeType":
"STANDARD",
-
"instanceSize":
"M10"
},
-
"autoScaling":
{
-
"compute":
{
-
"enabled":
true,
-
"maxInstanceSize":
"M10",
-
"minInstanceSize":
"M10",
-
"scaleDownEnabled":
true
},
-
"diskGB":
{
-
"enabled":
true
}
},
-
"readOnlySpecs":
{
-
"nodeCount":
0,
-
"diskIOPS":
0,
-
"ebsVolumeType":
"STANDARD",
-
"instanceSize":
"M10"
}
}
],
-
"zoneName":
"string"
}
],
-
"rootCertType":
"ISRGROOTX1",
-
"terminationProtectionEnabled": false,
-
"versionReleaseSystem": "LTS"
}
{
-
"backupEnabled":
false,
-
"biConnector":
{
-
"enabled":
true,
-
"readPreference":
"PRIMARY"
},
-
"clusterType":
"REPLICASET",
-
"connectionStrings": {
-
"awsPrivateLink":
{
-
"property1":
"string",
-
"property2":
"string"
},
-
"awsPrivateLinkSrv":
{
-
"property1":
"string",
-
"property2":
"string"
},
-
"private":
"string",
-
"privateEndpoint":
[
-
{
-
"connectionString":
"string",
-
"endpoints":
[
-
{
-
"endpointId":
"string",
-
"providerName":
"AWS",
-
"region":
"string"
}
],
-
"srvConnectionString":
"string",
-
"type":
"MONGOD"
}
],
-
"privateSrv": "string",
-
"standard":
"string",
-
"standardSrv":
"string"
},
-
"createDate":
"2019-08-24T14:15:22Z",
-
"diskSizeGB":
10,
-
"encryptionAtRestProvider": "NONE",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"6492cb3770e674ece4e89b41",
-
"labels":
[
-
{
-
"key":
"string",
-
"value":
"string"
}
],
-
"links":
[
-
],
-
"mongoDBMajorVersion": "4.0",
-
"mongoDBVersion":
"string",
-
"name":
"string",
-
"paused":
true,
-
"pitEnabled":
true,
-
"replicationSpecs": [
-
{
-
"id":
"6492cb3770e674ece4e89b41",
-
"numShards": 1,
-
"regionConfigs":
[
-
{
-
"electableSpecs":
{
-
"diskIOPS":
0,
-
"ebsVolumeType":
"STANDARD",
-
"instanceSize":
"M10",
-
"nodeCount":
0
},
-
"priority":
7,
-
"providerName":
"AWS",
-
"regionName":
"US_GOV_WEST_1",
-
"analyticsAutoScaling":
{
-
"compute":
{
-
"enabled":
true,
-
"maxInstanceSize":
"M10",
-
"minInstanceSize":
"M10",
-
"scaleDownEnabled":
true
},
-
"diskGB":
{
-
"enabled":
true
}
},
-
"analyticsSpecs":
{
-
"nodeCount":
0,
-
"diskIOPS":
0,
-
"ebsVolumeType":
"STANDARD",
-
"instanceSize":
"M10"
},
-
"autoScaling":
{
-
"compute":
{
-
"enabled":
true,
-
"maxInstanceSize":
"M10",
-
"minInstanceSize":
"M10",
-
"scaleDownEnabled":
true
},
-
"diskGB":
{
-
"enabled":
true
}
},
-
"readOnlySpecs":
{
-
"nodeCount":
0,
-
"diskIOPS":
0,
-
"ebsVolumeType":
"STANDARD",
-
"instanceSize":
"M10"
}
}
],
-
"zoneName":
"string"
}
],
-
"rootCertType":
"ISRGROOTX1",
-
"stateName":
"IDLE",
-
"terminationProtectionEnabled": false,
-
"versionReleaseSystem": "LTS"
}
Starts a failover test for the specified cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. A failover test checks how MongoDB Cloud handles the failure of the cluster's primary node. During the test, MongoDB Cloud shuts down the primary node and elects a new primary. To use this resource, the requesting API Key must have the Project Cluster Manager role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint)",
-
"error":
401,
-
"errorCode":
"NOT_ORG_GROUP_CREATOR",
-
"parameters":
[
-
"EXAMPLE"
],
-
"reason":
"Unauthorized"
}
Returns, adds, edits, and removes network peering containers and peering connections.
Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
|
providerName
required
|
string
Default:
"AWS"
Enum:
"AWS"
"AZURE"
"GCP"
Cloud service provider that serves the desired network peering containers. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"id":
"2f3ed24096c4b70db8993cb7",
-
"providerName":
"AWS",
-
"provisioned": true,
-
"atlasCidrBlock":
"string",
-
"azureSubscriptionId":
"6492cb3770e674ece4e89b41",
-
"region":
"US_CENTRAL",
-
"vnetName":
"stringstringstringstringstringstringst"
}
],
-
"totalCount":
0
}
Creates one new network peering container in the specified project. MongoDB Cloud can deploy Network Peering connections in a network peering container. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Creates one new network peering container in the specified project.
| providerName |
string
Cloud service provider that serves the requested network peering containers. |
| atlasCidrBlock |
string^((([0-9]{1,3}\.){3}[0-9]{1,3})|([\:]{0,2}([0...
IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.
These CIDR blocks must fall within the ranges reserved per RFC 1918.
AWS and Azure further limit the block to between the
To modify the CIDR block, the target project cannot have:
You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.
Example: A project in an Amazon Web Services (AWS)
region supporting three availability zones and an MongoDB CIDR
network peering container block of limit of |
|
regionName
required
|
string
Enum:
"US_EAST_1"
"US_EAST_2"
"US_WEST_1"
"US_WEST_2"
"CA_CENTRAL_1"
"EU_NORTH_1"
"EU_WEST_1"
"EU_WEST_2"
"EU_WEST_3"
"EU_CENTRAL_1"
"SA_EAST_1"
"AP_EAST_1"
"AP_SOUTHEAST_2"
"AP_SOUTHEAST_3"
"AP_NORTHEAST_1"
"AP_NORTHEAST_2"
"AP_NORTHEAST_3"
"AP_SOUTHEAST_1"
"AP_SOUTH_1"
"CN_NORTH_1"
"CN_NORTHWEST_1"
"ME_SOUTH_1"
"AF_SOUTH_1"
"EU_SOUTH_1"
"GLOBAL"
"US_GOV_WEST_1"
"US_GOV_EAST_1"
Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container. |
{
-
"providerName":
"AWS",
-
"atlasCidrBlock": "string",
-
"region":
"US_CENTRAL",
-
"regionName":
"US_EAST_1"
}
{
-
"id":
"2f3ed24096c4b70db8993cb7",
-
"providerName":
"AWS",
-
"provisioned":
true,
-
"atlasCidrBlock": "string",
-
"azureSubscriptionId":
"6492cb3770e674ece4e89b41",
-
"region":
"US_CENTRAL",
-
"vnetName":
"stringstringstringstringstringstringst",
-
"regionName":
"US_EAST_1",
-
"vpcId":
"vpc-b555d3b0d9cb783b0"
}
Returns details about all network peering containers in the specified project. Network peering containers contain network peering connections. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"id":
"2f3ed24096c4b70db8993cb7",
-
"providerName":
"AWS",
-
"provisioned": true,
-
"atlasCidrBlock":
"string",
-
"azureSubscriptionId":
"6492cb3770e674ece4e89b41",
-
"region":
"US_CENTRAL",
-
"vnetName":
"stringstringstringstringstringstringst"
}
],
-
"totalCount":
0
}
Removes one network peering container in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
containerId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
2f3ed24096c4b70db8993cb7
Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns details about one network peering container in one specified project. Network peering containers contain network peering connections. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
containerId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
2f3ed24096c4b70db8993cb7
Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"id":
"2f3ed24096c4b70db8993cb7",
-
"providerName":
"AWS",
-
"provisioned":
true,
-
"atlasCidrBlock": "string",
-
"azureSubscriptionId":
"6492cb3770e674ece4e89b41",
-
"region":
"US_CENTRAL",
-
"vnetName":
"stringstringstringstringstringstringst",
-
"regionName":
"US_EAST_1",
-
"vpcId":
"vpc-b555d3b0d9cb783b0"
}
Updates the network details and labels of one specified network peering container in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
containerId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
2f3ed24096c4b70db8993cb7
Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that you want to remove. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Updates the network details and labels of one specified network peering container in the specified project.
| providerName |
string
Cloud service provider that serves the requested network peering containers. |
| atlasCidrBlock |
string^((([0-9]{1,3}\.){3}[0-9]{1,3})|([\:]{0,2}([0...
IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.
These CIDR blocks must fall within the ranges reserved per RFC 1918.
AWS and Azure further limit the block to between the
To modify the CIDR block, the target project cannot have:
You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project.
Example: A project in an Amazon Web Services (AWS)
region supporting three availability zones and an MongoDB CIDR
network peering container block of limit of |
|
regionName
required
|
string
Enum:
"US_EAST_1"
"US_EAST_2"
"US_WEST_1"
"US_WEST_2"
"CA_CENTRAL_1"
"EU_NORTH_1"
"EU_WEST_1"
"EU_WEST_2"
"EU_WEST_3"
"EU_CENTRAL_1"
"SA_EAST_1"
"AP_EAST_1"
"AP_SOUTHEAST_2"
"AP_SOUTHEAST_3"
"AP_NORTHEAST_1"
"AP_NORTHEAST_2"
"AP_NORTHEAST_3"
"AP_SOUTHEAST_1"
"AP_SOUTH_1"
"CN_NORTH_1"
"CN_NORTHWEST_1"
"ME_SOUTH_1"
"AF_SOUTH_1"
"EU_SOUTH_1"
"GLOBAL"
"US_GOV_WEST_1"
"US_GOV_EAST_1"
Geographic area that Amazon Web Services (AWS) defines to which MongoDB Cloud deployed this network peering container. |
{
-
"providerName":
"AWS",
-
"atlasCidrBlock": "string",
-
"region":
"US_CENTRAL",
-
"regionName":
"US_EAST_1"
}
{
-
"id":
"2f3ed24096c4b70db8993cb7",
-
"providerName":
"AWS",
-
"provisioned":
true,
-
"atlasCidrBlock": "string",
-
"azureSubscriptionId":
"6492cb3770e674ece4e89b41",
-
"region":
"US_CENTRAL",
-
"vnetName":
"stringstringstringstringstringstringst",
-
"regionName":
"US_EAST_1",
-
"vpcId":
"vpc-b555d3b0d9cb783b0"
}
Returns details about all network peering connections in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| providerName |
string
Default:
"AWS"
Enum:
"AWS"
"AZURE"
"GCP"
Cloud service provider to use for this VPC peering connection. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"accepterRegionName":
"string",
-
"awsAccountId":
"stringstring",
-
"connectionId":
"string",
-
"containerId":
"2f3ed24096c4b70db8993cb7",
-
"errorStateName":
"REJECTED",
-
"id":
"f29c6d03c5ca80634eeba63b",
-
"routeTableCidrBlock":
"string",
-
"statusName":
"INITIATING",
-
"vpcId":
"string"
}
],
-
"totalCount":
0
}
Creates one new network peering connection in the specified project. Network peering allows multiple cloud-hosted applications to securely connect to the same project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Create one network peering connection.
|
containerId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection. |
|
providerName
required
|
string
Cloud service provider that determines the needed settings to configure the network connection for a virtual private connection. |
|
accepterRegionName
required
|
string
Amazon Web Services (AWS) region where the Virtual Peering
Connection (VPC) that you peered with the MongoDB Cloud VPC resides.
The resource returns |
|
awsAccountId
required
|
string
= 12 characters
^[0-9]{12}$
Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC. |
|
routeTableCidrBlock
required
|
string^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...
Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC. |
|
vpcId
required
|
string
>= 5 characters
^vpc-[0-9a-f]{17}$
Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC. |
{
-
"containerId":
"2f3ed24096c4b70db8993cb7",
-
"providerName":
"AWS",
-
"accepterRegionName": "string",
-
"awsAccountId":
"stringstring",
-
"routeTableCidrBlock": "string",
-
"vpcId":
"string"
}
{
-
"accepterRegionName": "string",
-
"awsAccountId":
"stringstring",
-
"connectionId":
"string",
-
"containerId":
"2f3ed24096c4b70db8993cb7",
-
"errorStateName": "REJECTED",
-
"id":
"f29c6d03c5ca80634eeba63b",
-
"routeTableCidrBlock": "string",
-
"statusName":
"INITIATING",
-
"vpcId":
"string"
}
Removes one network peering connection in the specified project. If you Removes the last network peering connection associated with a project, MongoDB Cloud also removes any AWS security groups from the project IP access list. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
peerId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the network peering connection that you want to delete. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) Cannot find resource
AWS",
-
"error":
404,
-
"errorCode":
"RESOURCE_NOT_FOUND",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Not Found"
}
Returns details about one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
peerId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the network peering connection that you want to retrieve. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"accepterRegionName": "string",
-
"awsAccountId":
"stringstring",
-
"connectionId":
"string",
-
"containerId":
"2f3ed24096c4b70db8993cb7",
-
"errorStateName": "REJECTED",
-
"id":
"f29c6d03c5ca80634eeba63b",
-
"routeTableCidrBlock": "string",
-
"statusName":
"INITIATING",
-
"vpcId":
"string"
}
Updates one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
peerId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Modify one network peering connection.
|
containerId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection. |
|
providerName
required
|
string
Cloud service provider that determines the needed settings to configure the network connection for a virtual private connection. |
|
accepterRegionName
required
|
string
Amazon Web Services (AWS) region where the Virtual Peering
Connection (VPC) that you peered with the MongoDB Cloud VPC resides.
The resource returns |
|
awsAccountId
required
|
string
= 12 characters
^[0-9]{12}$
Unique twelve-digit string that identifies the Amazon Web Services (AWS) account that owns the VPC that you peered with the MongoDB Cloud VPC. |
|
routeTableCidrBlock
required
|
string^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...
Internet Protocol (IP) addresses expressed in Classless Inter-Domain Routing (CIDR) notation of the VPC's subnet that you want to peer with the MongoDB Cloud VPC. |
|
vpcId
required
|
string
>= 5 characters
^vpc-[0-9a-f]{17}$
Unique string that identifies the VPC on Amazon Web Services (AWS) that you want to peer with the MongoDB Cloud VPC. |
{
-
"containerId":
"2f3ed24096c4b70db8993cb7",
-
"providerName":
"AWS",
-
"accepterRegionName": "string",
-
"awsAccountId":
"stringstring",
-
"routeTableCidrBlock": "string",
-
"vpcId":
"string"
}
{
-
"accepterRegionName": "string",
-
"awsAccountId":
"stringstring",
-
"connectionId":
"string",
-
"containerId":
"2f3ed24096c4b70db8993cb7",
-
"errorStateName": "REJECTED",
-
"id":
"f29c6d03c5ca80634eeba63b",
-
"routeTableCidrBlock": "string",
-
"statusName":
"INITIATING",
-
"vpcId":
"string"
}
Verifies if someone set the specified project to Connect via Peering Only mode. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"enabled":
true
}
Disables Connect via Peering Only mode for the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Disables Connect via Peering Only mode for the specified project.
|
enabled
required
|
boolean
Flag that indicates whether someone enabled Connect via Peering Only mode for the specified project. |
{
-
"enabled":
true
}
{
-
"enabled":
true
}
Returns details of all online archives. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster that contains the collection for which you want to return the online archives. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"clusterName":
"string",
-
"collName":
"string",
-
"collectionType":
"TIMESERIES",
-
"criteria":
{
-
"type":
"DATE"
},
-
"dbName":
"string",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"1f0df9ed79cfc99dbcc6f5d8",
-
"partitionFields":
[
-
{
-
"fieldName":
"string",
-
"fieldType":
"date",
-
"order":
0
}
],
-
"schedule":
{
-
"type":
"string"
},
-
"state":
"PENDING"
}
],
-
"totalCount":
0
}
Creates one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster that contains the collection for which you want to create one online archive. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Creates one online archive.
| collName |
string
Human-readable label that identifies the collection for which you created the online archive. |
| collectionType |
string
Default:
"STANDARD"
Enum:
"TIMESERIES"
"STANDARD"
Classification of MongoDB database collection that you want to return.
If you set this parameter to |
|
required
|
object
(CriteriaView)
Rules by which MongoDB MongoDB Cloud archives data. Use the criteria.type field to choose how MongoDB Cloud selects data to archive. Choose data using the age of the data or a MongoDB query. "criteria.type": "DATE" selects documents to archive based on a date. "criteria.type": "CUSTOM" selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support "criteria.type": "CUSTOM" when "collectionType": "TIMESERIES". |
| dbName |
string
Human-readable label of the database that contains the collection that contains the online archive. |
|
Array of objects
(Online Archive Partition)
non-empty
List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify up to two parameters that you frequently query. Any queries that don't use these parameters result in a full collection scan of all archived documents. This takes more time and increase your costs. |
|
|
object
(Online Archive Schedule)
Regular frequency and duration when archiving process occurs. |
{
-
"collName":
"string",
-
"collectionType":
"TIMESERIES",
-
"criteria":
{
-
"type":
"DATE"
},
-
"dbName":
"string",
-
"partitionFields": [
-
{
-
"fieldName":
"string",
-
"order": 0
}
],
-
"schedule":
{
-
"type":
"string"
}
}
{
-
"clusterName":
"string",
-
"collName":
"string",
-
"collectionType":
"TIMESERIES",
-
"criteria":
{
-
"type":
"DATE"
},
-
"dbName":
"string",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"1f0df9ed79cfc99dbcc6f5d8",
-
"partitionFields": [
-
{
-
"fieldName":
"string",
-
"fieldType":
"date",
-
"order": 0
}
],
-
"schedule":
{
-
"type":
"string"
},
-
"state":
"PENDING"
}
Downloads query logs for the specified online archive. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive. |
| startDate |
integer
<int64>
>= 1199145600
Example:
startDate=1636481348
Date and time that specifies the starting point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the UNIX epoch. |
| endDate |
integer
<int64>
>= 1199145600
Example:
endDate=1636481348
Date and time that specifies the end point for the range of log messages to return. This resource expresses this value in the number of seconds that have elapsed since the UNIX epoch. |
| archiveOnly |
boolean
Default:
false
Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Removes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
archiveId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the online archive to delete. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint)",
-
"error":
401,
-
"errorCode":
"NOT_ORG_GROUP_CREATOR",
-
"parameters":
[
-
"EXAMPLE"
],
-
"reason":
"Unauthorized"
}
Returns one online archive for one cluster. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
archiveId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the online archive to return. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"clusterName":
"string",
-
"collName":
"string",
-
"collectionType":
"TIMESERIES",
-
"criteria":
{
-
"type":
"DATE"
},
-
"dbName":
"string",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"1f0df9ed79cfc99dbcc6f5d8",
-
"partitionFields": [
-
{
-
"fieldName":
"string",
-
"fieldType":
"date",
-
"order": 0
}
],
-
"schedule":
{
-
"type":
"string"
},
-
"state":
"PENDING"
}
Updates, pauses, or resumes one online archive. This archive stores data from one cluster within one project. To use this resource, the requesting API Key must have the Project Data Access Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
archiveId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the online archive to update. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster that contains the specified collection from which Application created the online archive. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Updates, pauses, or resumes one online archive.
| collName |
string
Human-readable label that identifies the collection for which you created the online archive. |
| collectionType |
string
Default:
"STANDARD"
Enum:
"TIMESERIES"
"STANDARD"
Classification of MongoDB database collection that you want to return.
If you set this parameter to |
|
required
|
object
(CriteriaView)
Rules by which MongoDB MongoDB Cloud archives data. Use the criteria.type field to choose how MongoDB Cloud selects data to archive. Choose data using the age of the data or a MongoDB query. "criteria.type": "DATE" selects documents to archive based on a date. "criteria.type": "CUSTOM" selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support "criteria.type": "CUSTOM" when "collectionType": "TIMESERIES". |
| dbName |
string
Human-readable label of the database that contains the collection that contains the online archive. |
|
Array of objects
(Online Archive Partition)
non-empty
List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify up to two parameters that you frequently query. Any queries that don't use these parameters result in a full collection scan of all archived documents. This takes more time and increase your costs. |
|
|
object
(Online Archive Schedule)
Regular frequency and duration when archiving process occurs. |
{
-
"collName":
"string",
-
"collectionType":
"TIMESERIES",
-
"criteria":
{
-
"type":
"DATE"
},
-
"dbName":
"string",
-
"partitionFields": [
-
{
-
"fieldName":
"string",
-
"order": 0
}
],
-
"schedule":
{
-
"type":
"string"
}
}
{
-
"clusterName":
"string",
-
"collName":
"string",
-
"collectionType":
"TIMESERIES",
-
"criteria":
{
-
"type":
"DATE"
},
-
"dbName":
"string",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"1f0df9ed79cfc99dbcc6f5d8",
-
"partitionFields": [
-
{
-
"fieldName":
"string",
-
"fieldType":
"date",
-
"order": 0
}
],
-
"schedule":
{
-
"type":
"string"
},
-
"state":
"PENDING"
}
Returns all organizations to which you belong. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| name |
string
Human-readable label of the organization to use to filter the returned list. Performs a case-insensitive search for an organization that starts with the specified name. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"id":
"4888442a3354817a7320eb61",
-
"isDeleted": true,
-
"links":
[
-
],
-
"name":
"string"
}
],
-
"totalCount":
0
}
Removes one specified organization. MongoDB Cloud imposes the following limits on this resource:
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns one organization to which the requesting API key has access. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"id":
"4888442a3354817a7320eb61",
-
"isDeleted":
true,
-
"links":
[
-
],
-
"name":
"string"
}
Renames one organization. To use this resource, the requesting API Key must have the Organization Owner role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Details to update on the specified organization.
|
name
required
|
string
[ 1 .. 64 ] characters
^[\p{L}\p{N}\-_.(),:&@+']{1,64}$
Human-readable label that identifies the organization. |
{
-
"name":
"string"
}
{
-
"id":
"4888442a3354817a7320eb61",
-
"isDeleted":
true,
-
"links":
[
-
],
-
"name":
"string"
}
Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to:
To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| name |
string
Human-readable label of the project to use to filter the returned list. Performs a case-insensitive search for a project within the organization which is prefixed by the specified name. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"clusterCount": 0,
-
"created":
"2019-08-24T14:15:22Z",
-
"id":
"32b6e34b3d91647abb20e7b8",
-
"links":
[
-
],
-
"name":
"string",
-
"orgId":
"4888442a3354817a7320eb61"
}
],
-
"totalCount":
0
}
Returns all pending invitations to the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| username |
string
<email>
Email address of the user account invited to this organization. If you exclude this parameter, this resource returns all pending invitations. |
[
-
{
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"id":
"40a49d60a105686d534c8af6",
-
"inviterUsername":
"user@example.com",
-
"links":
[
-
],
-
"orgId":
"4888442a3354817a7320eb61",
-
"orgName":
"string",
-
"roles":
[
-
"ORG_OWNER"
],
-
"teamIds":
[
-
"e254e4ade2206f4520d4107d"
],
-
"username":
"user@example.com"
}
]
Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the username of the invited user. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Updates the details of one pending invitation to the specified organization.
| roles |
Array of strings
unique
Items
Enum:
"ORG_OWNER"
"ORG_MEMBER"
"ORG_GROUP_CREATOR"
"ORG_BILLING_ADMIN"
"ORG_READ_ONLY"
One or more organization or project level roles to assign to the MongoDB Cloud user. |
| teamIds |
Array of strings
unique
[ items
= 24 characters
^([a-f0-9]{24})$
]
List of teams to which you want to invite the desired MongoDB Cloud user. |
| username |
string
<email>
Email address that belongs to the desired MongoDB Cloud user. |
{
-
"roles":
[
-
"ORG_OWNER"
],
-
"teamIds":
[
-
"e254e4ade2206f4520d4107d"
],
-
"username":
"user@example.com"
}
{
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"id":
"40a49d60a105686d534c8af6",
-
"inviterUsername":
"user@example.com",
-
"links":
[
-
],
-
"orgId":
"4888442a3354817a7320eb61",
-
"orgName":
"string",
-
"roles":
[
-
"ORG_OWNER"
],
-
"teamIds":
[
-
"e254e4ade2206f4520d4107d"
],
-
"username":
"user@example.com"
}
Invites one MongoDB Cloud user to join the specified organization. The user must accept the invitation to access information within the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Invites one MongoDB Cloud user to join the specified organization.
| roles |
Array of strings
unique
Items
Enum:
"ORG_OWNER"
"ORG_MEMBER"
"ORG_GROUP_CREATOR"
"ORG_BILLING_ADMIN"
"ORG_READ_ONLY"
One or more organization or project level roles to assign to the MongoDB Cloud user. |
| teamIds |
Array of strings
unique
[ items
= 24 characters
^([a-f0-9]{24})$
]
List of teams to which you want to invite the desired MongoDB Cloud user. |
| username |
string
<email>
Email address that belongs to the desired MongoDB Cloud user. |
{
-
"roles":
[
-
"ORG_OWNER"
],
-
"teamIds":
[
-
"e254e4ade2206f4520d4107d"
],
-
"username":
"user@example.com"
}
{
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"id":
"40a49d60a105686d534c8af6",
-
"inviterUsername":
"user@example.com",
-
"links":
[
-
],
-
"orgId":
"4888442a3354817a7320eb61",
-
"orgName":
"string",
-
"roles":
[
-
"ORG_OWNER"
],
-
"teamIds":
[
-
"e254e4ade2206f4520d4107d"
],
-
"username":
"user@example.com"
}
Cancels one pending invitation sent to the specified MongoDB Cloud user to join an organization. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
|
invitationId
required
|
string
Unique 24-hexadecimal digit string that identifies the invitation. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns the details of one pending invitation to the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
|
invitationId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the invitation. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"id":
"40a49d60a105686d534c8af6",
-
"inviterUsername":
"user@example.com",
-
"links":
[
-
],
-
"orgId":
"4888442a3354817a7320eb61",
-
"orgName":
"string",
-
"roles":
[
-
"ORG_OWNER"
],
-
"teamIds":
[
-
"e254e4ade2206f4520d4107d"
],
-
"username":
"user@example.com"
}
Updates the details of one pending invitation to the specified organization. To specify which invitation, provide the unique identification string for that invitation. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
|
invitationId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the invitation. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Updates the details of one pending invitation to the specified organization.
| roles |
Array of strings
unique
Items
Enum:
"ORG_OWNER"
"ORG_MEMBER"
"ORG_GROUP_CREATOR"
"ORG_BILLING_ADMIN"
"ORG_READ_ONLY"
One or more organization or project level roles to assign to the MongoDB Cloud user. |
| teamIds |
Array of strings
unique
[ items
= 24 characters
^([a-f0-9]{24})$
]
List of teams to which you want to invite the desired MongoDB Cloud user. |
{
-
"roles":
[
-
"ORG_OWNER"
],
-
"teamIds":
[
-
"e254e4ade2206f4520d4107d"
]
}
{
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"id":
"40a49d60a105686d534c8af6",
-
"inviterUsername":
"user@example.com",
-
"links":
[
-
],
-
"orgId":
"4888442a3354817a7320eb61",
-
"orgName":
"string",
-
"roles":
[
-
"ORG_OWNER"
],
-
"teamIds":
[
-
"e254e4ade2206f4520d4107d"
],
-
"username":
"user@example.com"
}
Returns details about the MongoDB Cloud users associated with the specified organization. Each MongoDB Cloud user returned must belong to the specified organization or to a project within the specified organization. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"country":
"string",
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"emailAddress":
"user@example.com",
-
"firstName":
"string",
-
"id":
"887821d389de9fe084df2bdf",
-
"lastAuth":
"2019-08-24T14:15:22Z",
-
"lastName":
"string",
-
"links":
[
-
],
-
"mobileNumber":
"string",
-
"password":
"stringst",
-
"roles":
[
-
{
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"orgId":
"4888442a3354817a7320eb61",
-
"roleName":
"ORG_OWNER"
}
],
-
"teamIds":
[
-
"e254e4ade2206f4520d4107d"
],
-
"username":
"user@example.com"
}
],
-
"totalCount":
0
}
Returns suggested indexes and slow query data for a database deployment. Also enables or disables MongoDB Cloud-managed slow operation thresholds.
Disables the slow operation threshold that MongoDB Cloud calculated for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. To use this resource, the requesting API Key must have the Project Owner role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint)",
-
"error":
401,
-
"errorCode":
"NOT_ORG_GROUP_CREATOR",
-
"parameters":
[
-
"EXAMPLE"
],
-
"reason":
"Unauthorized"
}
Enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. To use this resource, the requesting API Key must have the Project Owner role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint)",
-
"error":
401,
-
"errorCode":
"NOT_ORG_GROUP_CREATOR",
-
"parameters":
[
-
"EXAMPLE"
],
-
"reason":
"Unauthorized"
}
Returns up to 20 namespaces for collections experiencing slow queries on the specified host. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
processId
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Combination of host and port that serves the MongoDB process. The
host must be the hostname, FQDN, IPv4 address, or IPv6 address of
the host that runs the MongoDB process ( |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| duration |
integer
<int64>
Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.
|
| since |
integer
<int64>
>= 1199145600
Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.
|
{
-
"namespaces":
[
-
{
-
"namespace":
"string",
-
"type":
"collection"
}
]
}
Returns log lines for slow queries that the Performance Advisor and Query Profiler identified. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. MongoDB Cloud bases the threshold for slow queries on the average time of operations on your cluster. This enables workload-relevant recommendations. To use this resource, the requesting API Key must have the Project Data Access Read Write role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
processId
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Combination of host and port that serves the MongoDB process. The
host must be the hostname, FQDN, IPv4 address, or IPv6 address of
the host that runs the MongoDB process ( |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| duration |
integer
<int64>
Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.
|
| namespaces |
Array of strings
Namespaces from which to retrieve suggested indexes. A namespace
consists of one database and one collection resource written as
|
| nLogs |
integer
<int64>
[ 0 .. 20000 ]
Default:
20000
Maximum number of lines from the log to return. |
| since |
integer
<int64>
>= 1199145600
Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.
|
{
-
"slowQueries":
[
-
{
-
"line":
"string",
-
"namespace":
"string"
}
]
}
Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
processId
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\:...
Combination of host and port that serves the MongoDB process. The
host must be the hostname, FQDN, IPv4 address, or IPv6 address of
the host that runs the MongoDB process ( |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| duration |
number
Length of time expressed during which the query finds suggested indexes among the managed namespaces in the cluster. This parameter expresses its value in milliseconds.
|
| namespaces |
Array of strings
Namespaces from which to retrieve suggested indexes. A namespace
consists of one database and one collection resource written as
|
| nExamples |
integer
<int64>
Default:
5
Maximum number of example queries that benefit from the suggested index. |
| nIndexes |
integer
<int64>
Number that indicates the maximum indexes to suggest. |
| since |
number
Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.
|
{
-
"shapes":
[
-
{
-
"avgMs": 0,
-
"count": 0,
-
"id":
"stringstringstringstring",
-
"inefficiencyScore": 0,
-
"namespace":
"string",
-
"operations":
[
-
{
-
"predicates":
[
-
{ }
],
-
"stats":
{
-
"ms":
0,
-
"nReturned":
0,
-
"nScanned":
0,
-
"ts":
0
}
}
]
}
],
-
"suggestedIndexes": [
-
{
-
"avgObjSize": 0,
-
"id":
"stringstringstringstring",
-
"impact":
[
-
"stringstringstringstring"
],
-
"index":
[
-
{
-
"property1":
"1",
-
"property2":
"1"
}
],
-
"namespace":
"string",
-
"weight": 0
}
]
}
Creates one private resource service for the specified cloud service provider. This cloud service provider manages the private resource service for the project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Creates one private resource service for the specified cloud service provider.
|
providerName
required
|
string
Enum:
"AWS"
"AZURE"
"GCP"
Human-readable label that identifies the cloud service provider for which you want to create the private endpoint service. |
|
region
required
|
string
Cloud provider region in which you want to create the private endpoint service. Regions accepted as values differ for Amazon Web Services, Google Cloud Platform, and Microsoft Azure. |
{
-
"providerName":
"AWS",
-
"region":
"string"
}
{
-
"endpointServiceName": "string",
-
"errorMessage":
"string",
-
"id":
"3a876d84705fbf5833488cde",
-
"interfaceEndpoints":
[
-
"b55c6e799a3f084e9972f874"
],
-
"regionName":
"string",
-
"status":
"INITIATING"
}
Checks whether each region in the specified cloud service provider can create multiple private resources per region. The cloud service provider manages the private resource for the project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"enabled":
true
}
Enables or disables the ability can create multiple private resources per region in all cloud service providers in one project. The cloud service provider manages the private resource for the project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Enables or disables the ability can create multiple private resources per region in all cloud service providers in one project.
|
enabled
required
|
boolean
Flag that indicates whether someone enabled the regionalized private endpoint setting for the specified project.
|
{
-
"enabled":
true
}
{
-
"enabled":
true
}
Returns the name, interfaces, and state of all private resource services for the specified cloud service provider. This cloud service provider manages the private resource service for the project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
cloudProvider
required
|
string
Default:
"AWS"
Enum:
"AWS"
"AZURE"
"GCP"
Cloud service provider that manages this private endpoint service. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"errorMessage":
"string",
-
"id":
"3a876d84705fbf5833488cde",
-
"regionName":
"string",
-
"status":
"INITIATING",
-
"endpointServiceName":
"string",
-
"interfaceEndpoints":
[
-
"b55c6e799a3f084e9972f874"
]
}
],
-
"totalCount":
0
}
Removes one private resource service from the specified project. This cloud service provider manages the private resource service that belongs to the project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
cloudProvider
required
|
string
Default:
"AWS"
Enum:
"AWS"
"AZURE"
"GCP"
Cloud service provider that manages this private endpoint service. |
|
endpointServiceId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to delete. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns the name, interfaces, and state of the specified private resource service from one project. The cloud service provider hosted this private resource service that belongs to the project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
cloudProvider
required
|
string
Default:
"AWS"
Enum:
"AWS"
"AZURE"
"GCP"
Cloud service provider that manages this private endpoint service. |
|
endpointServiceId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the private endpoint service that you want to return. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"endpointServiceName": "string",
-
"errorMessage":
"string",
-
"id":
"3a876d84705fbf5833488cde",
-
"interfaceEndpoints":
[
-
"b55c6e799a3f084e9972f874"
],
-
"regionName":
"string",
-
"status":
"INITIATING"
}
Creates one private resource in the specified private resource service hosted from one cloud service provider. This cloud service provider manages the private resource service for the project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
cloudProvider
required
|
string
Default:
"AWS"
Enum:
"AWS"
"AZURE"
"GCP"
Cloud service provider that manages this private endpoint. |
|
endpointServiceId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to create a private endpoint. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Creates one private resource endpoint for the specified cloud service provider.
| id |
string^vpce-[0-9a-f]{17}$
Unique string that identifies the private endpoint's network interface that someone added to this private endpoint service. |
{
-
"id":
"vpce-3bf78b0ddee411ba1"
}
{
-
"connectionStatus":
"PENDING_ACCEPTANCE",
-
"deleteRequested": true,
-
"errorMessage":
"string",
-
"interfaceEndpointId":
"b55c6e799a3f084e9972f874"
}
Removes one private resource from the specified project. This cloud service provider manages the private resource service that manages the private resource that belongs to the project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
cloudProvider
required
|
string
Default:
"AWS"
Enum:
"AWS"
"AZURE"
"GCP"
Cloud service provider that manages this private endpoint. |
|
endpointId
required
|
string^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF]...
Unique string that identifies the private endpoint you want to delete. The format of the endpointId parameter differs for AWS and Azure. You must URL encode the endpointId for Azure private endpoints. |
|
endpointServiceId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the private endpoint service from which you want to delete a private endpoint. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns the connection state of the specified private resource. The private resource service manages this private resource which belongs to one project hosted from one cloud service provider. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
cloudProvider
required
|
string
Default:
"AWS"
Enum:
"AWS"
"AZURE"
"GCP"
Cloud service provider that manages this private endpoint. |
|
endpointId
required
|
string^vpce-[0-9a-f]{17}|^%2[fF]subscriptions%2[fF]...
Unique string that identifies the private endpoint you want to return. The format of the endpointId parameter differs for AWS and Azure. You must URL encode the endpointId for Azure private endpoints. |
|
endpointServiceId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the private endpoint service for which you want to return a private endpoint. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"connectionStatus":
"PENDING_ACCEPTANCE",
-
"deleteRequested": true,
-
"errorMessage":
"string",
-
"interfaceEndpointId":
"b55c6e799a3f084e9972f874"
}
Returns, adds, edits, and removes access tokens to use the MongoDB Cloud API. MongoDB Cloud applies these keys to organizations. These resources can return, assign, or revoke use of these keys within a specified project.
Returns all organization API keys that you assigned to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"desc":
"string",
-
"id":
"69f24ec71f746985759551c7",
-
"links":
[
-
],
-
"privateKey":
"55c3bbb6-b4bb-0be1-e66d20841f3e",
-
"publicKey":
"zmmrboas",
-
"roles":
[
-
{
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"orgId":
"4888442a3354817a7320eb61",
-
"roleName":
"ORG_OWNER"
}
]
}
],
-
"totalCount":
0
}
Creates and assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Organization API key to be created and assigned to the specified project. This request requires a minimum of one of the two body parameters.
| desc |
string
[ 1 .. 250 ] characters
Purpose or explanation provided when someone created this organization API key. |
| roles |
Array of strings
Items
Enum:
"ORG_OWNER"
"ORG_MEMBER"
"ORG_GROUP_CREATOR"
"ORG_BILLING_ADMIN"
"ORG_READ_ONLY"
List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization or project. |
{
-
"desc":
"string",
-
"roles":
[
-
"ORG_OWNER"
]
}
{
-
"desc":
"string",
-
"id":
"69f24ec71f746985759551c7",
-
"links":
[
-
],
-
"privateKey":
"55c3bbb6-b4bb-0be1-e66d20841f3e",
-
"publicKey":
"zmmrboas",
-
"roles":
[
-
{
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"orgId":
"4888442a3354817a7320eb61",
-
"roleName":
"ORG_OWNER"
}
]
}
Removes one organization API key from the specified project. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
apiUserId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Updates the roles of the organization API key that you specify for the project that you specify. You must specify at least one valid role for the project. The application removes any roles that you do not include in this request if they were previously set in the organization API key that you specify for the project.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
apiUserId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies this organization API key that you want to unassign from one project. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Organization API Key to be updated. This request requires a minimum of one of the two body parameters.
| desc |
string
[ 1 .. 250 ] characters
Purpose or explanation provided when someone created this organization API key. |
| roles |
Array of strings
Items
Enum:
"ORG_OWNER"
"ORG_MEMBER"
"ORG_GROUP_CREATOR"
"ORG_BILLING_ADMIN"
"ORG_READ_ONLY"
List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization or project. |
{
-
"desc":
"string",
-
"roles":
[
-
"ORG_OWNER"
]
}
{
-
"desc":
"string",
-
"id":
"69f24ec71f746985759551c7",
-
"links":
[
-
],
-
"privateKey":
"55c3bbb6-b4bb-0be1-e66d20841f3e",
-
"publicKey":
"zmmrboas",
-
"roles":
[
-
{
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"orgId":
"4888442a3354817a7320eb61",
-
"roleName":
"ORG_OWNER"
}
]
}
Assigns the specified organization API key to the specified project. Users with the Project Owner role in the project associated with the API key can then use the organization API key to access the resources. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
apiUserId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies this organization API key that you want to assign to one project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Organization API key to be assigned to the specified project.
| roles |
Array of strings
Items
Enum:
"GROUP_CLUSTER_MANAGER"
"GROUP_DATA_ACCESS_ADMIN"
"GROUP_DATA_ACCESS_READ_ONLY"
"GROUP_DATA_ACCESS_READ_WRITE"
"GROUP_SEARCH_INDEX_EDITOR"
"GROUP_OWNER"
"GROUP_READ_ONLY"
List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this project. |
[
-
{
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
]
}
]
{
-
"desc":
"string",
-
"id":
"69f24ec71f746985759551c7",
-
"links":
[
-
],
-
"privateKey":
"55c3bbb6-b4bb-0be1-e66d20841f3e",
-
"publicKey":
"zmmrboas",
-
"roles":
[
-
{
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"orgId":
"4888442a3354817a7320eb61",
-
"roleName":
"ORG_OWNER"
}
]
}
Returns all organization API keys for the specified organization. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the console. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"desc":
"string",
-
"id":
"69f24ec71f746985759551c7",
-
"links":
[
-
],
-
"privateKey":
"55c3bbb6-b4bb-0be1-e66d20841f3e",
-
"publicKey":
"zmmrboas",
-
"roles":
[
-
{
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"orgId":
"4888442a3354817a7320eb61",
-
"roleName":
"ORG_OWNER"
}
]
}
],
-
"totalCount":
0
}
Creates one API key for the specified organization. An organization API key grants programmatic access to an organization. You can't use the API key to log into the console. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Organization API Key to be created. This request requires a minimum of one of the two body parameters.
| desc |
string
[ 1 .. 250 ] characters
Purpose or explanation provided when someone created this organization API key. |
| roles |
Array of strings
Items
Enum:
"ORG_OWNER"
"ORG_MEMBER"
"ORG_GROUP_CREATOR"
"ORG_BILLING_ADMIN"
"ORG_READ_ONLY"
List of roles to grant this API key. If you provide this list, provide a minimum of one role and ensure each role applies to this organization or project. |
{
-
"desc":
"string",
-
"roles":
[
-
"ORG_OWNER"
]
}
{
-
"desc":
"string",
-
"id":
"69f24ec71f746985759551c7",
-
"links":
[
-
],
-
"privateKey":
"55c3bbb6-b4bb-0be1-e66d20841f3e",
-
"publicKey":
"zmmrboas",
-
"roles":
[
-
{
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"orgId":
"4888442a3354817a7320eb61",
-
"roleName":
"ORG_OWNER"
}
]
}
Removes one organization API key from the specified organization. When you remove an API key from an organization, MongoDB Cloud also removes that key from any projects that use that key. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
|
apiUserId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies this organization API key. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint)",
-
"error":
401,
-
"errorCode":
"NOT_ORG_GROUP_CREATOR",
-
"parameters":
[
-
"EXAMPLE"
],
-
"reason":
"Unauthorized"
}
Returns one organization API key. The organization API keys grant programmatic access to an organization. You can't use the API key to log into MongoDB Cloud through the user interface. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
|
apiUserId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies this organization API key that you want to update. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"desc":
"string",
-
"id":
"69f24ec71f746985759551c7",
-
"links":
[
-
],
-
"privateKey":
"55c3bbb6-b4bb-0be1-e66d20841f3e",
-
"publicKey":
"zmmrboas",
-
"roles":
[
-
{
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"orgId":
"4888442a3354817a7320eb61",
-
"roleName":
"ORG_OWNER"
}
]
}
Updates one organization API key in the specified organization. The organization API keys grant programmatic access to an organization. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
|
apiUserId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies this organization API key you want to update. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Organization API key to be updated. This request requires a minimum of one of the two body parameters.
| desc |
string
[ 1 .. 250 ] characters
Purpose or explanation provided when someone created this organization API key. |
|
Array of objects
(Role Assignment)
List that contains the roles that the API key needs to have. All roles you provide must be valid for the specified project or organization. Each request must include a minimum of one valid role. The resource returns all project and organization roles assigned to the API key. |
{
-
"desc":
"string",
-
"roles":
[
-
{
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"orgId":
"4888442a3354817a7320eb61",
-
"roleName":
"ORG_OWNER"
}
]
}
{
-
"desc":
"string",
-
"id":
"69f24ec71f746985759551c7",
-
"links":
[
-
],
-
"privateKey":
"55c3bbb6-b4bb-0be1-e66d20841f3e",
-
"publicKey":
"zmmrboas",
-
"roles":
[
-
{
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"orgId":
"4888442a3354817a7320eb61",
-
"roleName":
"ORG_OWNER"
}
]
}
Returns all access list entries that you configured for the specified organization API key. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
|
apiUserId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"cidrBlock":
"203.0.113.0/24",
-
"count": 1,
-
"created":
"2019-08-24T14:15:22Z",
-
"ipAddress":
"203.0.113.10",
-
"lastUsed":
"2019-08-24T14:15:22Z",
-
"lastUsedAddress":
"203.0.113.10",
-
"links":
[
-
]
}
],
-
"totalCount":
0
}
Creates the access list entries for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role and an entry for the project access list.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
|
apiUserId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies this organization API key for which you want to create a new access list entry. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Access list entries to be created for the specified organization API key.
| cidrBlock |
string^((([0-9]{1,3}\.){3}[0-9]{1,3})|([\:]{0,2}([0...
Range of network addresses that you want to add to the access list for the API key. This parameter requires the range to be expressed in classless inter-domain routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or ipAddress but not both in the same request. |
| ipAddress |
string^((([0-9]{1,3}\.){3}[0-9]{1,3})|([\:]{0,2}([0...
Network address that you want to add to the access list for the API key. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or cidrBlock but not both in the same request. |
[
-
{
-
"cidrBlock":
"203.0.113.0/24",
-
"ipAddress":
"203.0.113.10"
}
]
{
-
"cidrBlock":
"203.0.113.0/24",
-
"count":
1,
-
"created":
"2019-08-24T14:15:22Z",
-
"ipAddress":
"203.0.113.10",
-
"lastUsed":
"2019-08-24T14:15:22Z",
-
"lastUsedAddress": "203.0.113.10",
-
"links":
[
-
]
}
Removes the specified access list entry from the specified organization API key. Resources require all API requests originate from the IP addresses on the API access list. To use this resource, the requesting API Key must have the Read Write role and an entry for the project access list.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
|
apiUserId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies this organization API key for which you want to remove access list entries. |
|
ipAddress
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
Example:
192.0.2.0%2F24
One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns one access list entry for the specified organization API key. Resources require all API requests originate from IP addresses on the API access list. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
|
ipAddress
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
Example:
192.0.2.0%2F24
One IP address or multiple IP addresses represented as one CIDR block to limit requests to API resources in the specified organization. When adding a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /. |
|
apiUserId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies this organization API key for which you want to return access list entries. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"cidrBlock":
"203.0.113.0/24",
-
"count":
1,
-
"created":
"2019-08-24T14:15:22Z",
-
"ipAddress":
"203.0.113.10",
-
"lastUsed":
"2019-08-24T14:15:22Z",
-
"lastUsedAddress": "203.0.113.10",
-
"links":
[
-
]
}
Returns, adds, edits, and removes network access limits to database deployments in MongoDB Cloud.
Returns all access list entries from the specified project's IP access list. Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"awsSecurityGroup":
"string",
-
"cidrBlock":
"string",
-
"comment":
"string",
-
"deleteAfterDate":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"ipAddress":
"string",
-
"links":
[
-
]
}
],
-
"totalCount":
0
}
Adds one or more access list entries to the specified project. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. Write each entry as either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting API Key must have the Project Atlas Admin or Project Charts Admin roles. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
One or more access list entries to add to the specified project.
| awsSecurityGroup |
string^([0-9]*\/)?sg-([0-9]*)
Unique string of the Amazon Web Services (AWS) security group that you want to add to the project's IP access list. Your IP access list entry can be one awsSecurityGroup, one cidrBlock, or one ipAddress. You must configure Virtual Private Connection (VPC) peering for your project before you can add an AWS security group to an IP access list. You cannot set AWS security groups as temporary access list entries. Don't set this parameter if you set cidrBlock or ipAddress. |
| cidrBlock |
string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
Range of IP addresses in Classless Inter-Domain Routing (CIDR) notation that you want to add to the project's IP access list. Your IP access list entry can be one awsSecurityGroup, one cidrBlock, or one ipAddress. Don't set this parameter if you set awsSecurityGroup or ipAddress. |
| comment |
string
<= 80 characters
Remark that explains the purpose or scope of this IP access list entry. |
| deleteAfterDate |
string
<date-time>
Date and time after which MongoDB Cloud deletes the temporary access list entry. This parameter expresses its value in the ISO 8601 timestamp format in UTC and can include the time zone designation. The date must be later than the current date but no later than one week after you submit this request. The resource returns this parameter if you specified an expiration date when creating this IP access list entry. |
| ipAddress |
string^((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)(\.(?!$)|$))...
IP address that you want to add to the project's IP access list. Your IP access list entry can be one awsSecurityGroup, one cidrBlock, or one ipAddress. Don't set this parameter if you set awsSecurityGroup or cidrBlock. |
[
-
{
-
"awsSecurityGroup": "string",
-
"cidrBlock": "string",
-
"comment":
"string",
-
"deleteAfterDate":
"2019-08-24T14:15:22Z",
-
"ipAddress":
"string"
}
]
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"awsSecurityGroup":
"string",
-
"cidrBlock":
"string",
-
"comment":
"string",
-
"deleteAfterDate":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"ipAddress":
"string",
-
"links":
[
-
]
}
],
-
"totalCount":
0
}
Removes one access list entry from the specified project's IP access list. Each entry in the project's IP access list contains one IP address, one CIDR-notated block of IP addresses, or one AWS Security Group ID. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
entryValue
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
Example:
IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348
or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS
SG: sg-903004f8
Access list entry that you want to remove from the project's
IP access list. This value can use one of the following: one AWS
security group ID, one IP address, or one CIDR block of addresses.
For CIDR blocks that use a subnet mask, replace the forward slash
(
|
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint)",
-
"error":
403,
-
"errorCode":
"CANNOT_CHANGE_GROUP_NAME",
-
"parameters":
[
-
"EXAMPLE"
],
-
"reason":
"Forbidden"
}
Returns one access list entry from the specified project's IP access list. The project's IP access list entry contains either one IP address or one CIDR-notated block of IP addresses. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
entryValue
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
Example:
IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348
or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS
SG: sg-903004f8
Access list entry that you want to return from the project's
IP access list. This value can use one of the following: one AWS
security group ID, one IP address, or one CIDR block of addresses.
For CIDR blocks that use a subnet mask, replace the forward slash
( |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"awsSecurityGroup": "string",
-
"cidrBlock":
"string",
-
"comment":
"string",
-
"deleteAfterDate":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"ipAddress":
"string",
-
"links":
[
-
]
}
Returns the status of one project IP access list entry. This resource checks if the provided project IP access list entry applies to all cloud providers serving clusters from the specified project.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
entryValue
required
|
string^([0-9]{1,3}\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3}...
Example:
IPv4: 192.0.2.0%2F24 or IPv6: 2001:db8:85a3:8d3:1319:8a2e:370:7348
or IPv4 CIDR: 198.51.100.0%2f24 or IPv6 CIDR: 2001:db8::%2f58 or AWS
SG: sg-903004f8
Network address or cloud provider security construct that identifies which project access list entry to be verified. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"STATUS":
"PENDING"
}
Returns details about all projects. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this resource, the requesting API Key must have the Read Write role. This resource doesn't require the API Key to have an Access List.
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"clusterCount": 0,
-
"created":
"2019-08-24T14:15:22Z",
-
"id":
"32b6e34b3d91647abb20e7b8",
-
"links":
[
-
],
-
"name":
"string",
-
"orgId":
"4888442a3354817a7320eb61"
}
],
-
"totalCount":
0
}
Creates one project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this resource, the requesting API Key must have the Read Write role. This resource doesn't require the API Key to have an Access List.
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| projectOwnerId |
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user to whom to grant the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner. |
Creates one project.
|
name
required
|
string
[ 1 .. 64 ] characters
^[\p{L}\p{N}\-_.(),:&@+']{1,64}$
Human-readable label that identifies the project included in the MongoDB Cloud organization. |
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs. |
| withDefaultAlertsSettings |
boolean
Flag that indicates whether to create the project with default alert settings. |
{
-
"name":
"string",
-
"orgId":
"4888442a3354817a7320eb61",
-
"withDefaultAlertsSettings": true
}
{
-
"clusterCount":
0,
-
"created":
"2019-08-24T14:15:22Z",
-
"id":
"32b6e34b3d91647abb20e7b8",
-
"links":
[
-
],
-
"name":
"string",
-
"orgId":
"4888442a3354817a7320eb61"
}
Returns details about the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupName
required
|
string
[ 1 .. 64 ] characters
Human-readable label that identifies this project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"clusterCount":
0,
-
"created":
"2019-08-24T14:15:22Z",
-
"id":
"32b6e34b3d91647abb20e7b8",
-
"links":
[
-
],
-
"name":
"string",
-
"orgId":
"4888442a3354817a7320eb61"
}
Removes the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this resource, the requesting API Key must have the Project Owner role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns details about the specified project. Projects group clusters into logical collections that support an application environment, workload, or both. Each project can have its own users, teams, security, and alert settings. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"clusterCount":
0,
-
"created":
"2019-08-24T14:15:22Z",
-
"id":
"32b6e34b3d91647abb20e7b8",
-
"links":
[
-
],
-
"name":
"string",
-
"orgId":
"4888442a3354817a7320eb61"
}
Returns all pending invitations to the specified project. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| username |
string
<email>
Email address of the user account invited to this project. |
[
-
{
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"groupName": "string",
-
"id":
"217a865625b2bad3b9a1e93d",
-
"inviterUsername":
"user@example.com",
-
"links":
[
-
],
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"username":
"user@example.com"
}
]
Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the username of the invited user. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Updates the details of one pending invitation to the specified project.
| roles |
Array of strings
unique
Items
Enum:
"GROUP_CLUSTER_MANAGER"
"GROUP_DATA_ACCESS_ADMIN"
"GROUP_DATA_ACCESS_READ_ONLY"
"GROUP_DATA_ACCESS_READ_WRITE"
"GROUP_OWNER"
"GROUP_READ_ONLY"
One or more organization or project level roles to assign to the MongoDB Cloud user. |
| username |
string
<email>
Email address of the MongoDB Cloud user invited to the specified project. |
{
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"username":
"user@example.com"
}
{
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"groupName":
"string",
-
"id":
"217a865625b2bad3b9a1e93d",
-
"inviterUsername":
"user@example.com",
-
"links":
[
-
],
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"username":
"user@example.com"
}
Invites one MongoDB Cloud user to join the specified project. The MongoDB Cloud user must accept the invitation to access information within the specified project. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
Invites one MongoDB Cloud user to join the specified project.
| roles |
Array of strings
unique
Items
Enum:
"GROUP_CLUSTER_MANAGER"
"GROUP_DATA_ACCESS_ADMIN"
"GROUP_DATA_ACCESS_READ_ONLY"
"GROUP_DATA_ACCESS_READ_WRITE"
"GROUP_OWNER"
"GROUP_READ_ONLY"
One or more organization or project level roles to assign to the MongoDB Cloud user. |
| username |
string
<email>
Email address of the MongoDB Cloud user invited to the specified project. |
{
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"username":
"user@example.com"
}
{
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"groupName":
"string",
-
"id":
"217a865625b2bad3b9a1e93d",
-
"inviterUsername":
"user@example.com",
-
"links":
[
-
],
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"username":
"user@example.com"
}
Cancels one pending invitation sent to the specified MongoDB Cloud user to join a project. You can't cancel an invitation that the user accepted. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
invitationId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the invitation. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint)",
-
"error":
401,
-
"errorCode":
"NOT_ORG_GROUP_CREATOR",
-
"parameters":
[
-
"EXAMPLE"
],
-
"reason":
"Unauthorized"
}
Returns the details of one pending invitation to the specified project. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
invitationId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the invitation. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"groupName":
"string",
-
"id":
"217a865625b2bad3b9a1e93d",
-
"inviterUsername":
"user@example.com",
-
"links":
[
-
],
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"username":
"user@example.com"
}
Updates the details of one pending invitation to the specified project. To specify which invitation to update, provide the unique identification string for that invitation. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
invitationId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the invitation. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
Updates the details of one pending invitation to the specified project.
| roles |
Array of strings
unique
Items
Enum:
"GROUP_CLUSTER_MANAGER"
"GROUP_DATA_ACCESS_ADMIN"
"GROUP_DATA_ACCESS_READ_ONLY"
"GROUP_DATA_ACCESS_READ_WRITE"
"GROUP_OWNER"
"GROUP_READ_ONLY"
One or more organization or project level roles to assign to the MongoDB Cloud user. |
{
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
]
}
{
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"expiresAt":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"groupName":
"string",
-
"id":
"217a865625b2bad3b9a1e93d",
-
"inviterUsername":
"user@example.com",
-
"links":
[
-
],
-
"roles":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"username":
"user@example.com"
}
Returns all the limits for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"currentUsage":
0,
-
"defaultLimit":
0,
-
"maximumLimit":
0,
-
"name":
"atlas.project.deployment.clusters",
-
"value":
0
}
Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting API Key must have the Project Owner role. This resource doesn't require the API Key to have an Access List.
|
limitName
required
|
string
Enum:
"atlas.project.security.databaseAccess.users"
"atlas.project.deployment.clusters"
"atlas.project.security.databaseAccess.customRoles"
"atlas.project.security.networkAccess.entries"
"atlas.project.security.networkAccess.crossRegionEntries"
"atlas.project.deployment.nodesPerPrivateLinkRegion"
"dataFederation.bytesProcessed.query"
"dataFederation.bytesProcessed.daily"
"dataFederation.bytesProcessed.weekly"
"dataFederation.bytesProcessed.monthly"
Human-readable label that identifies this project limit.
|
|||||||||||||||||||||||||||||||||
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns the specified limit for the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
limitName
required
|
string
Enum:
"atlas.project.security.databaseAccess.users"
"atlas.project.deployment.clusters"
"atlas.project.security.databaseAccess.customRoles"
"atlas.project.security.networkAccess.entries"
"atlas.project.security.networkAccess.crossRegionEntries"
"atlas.project.deployment.nodesPerPrivateLinkRegion"
"dataFederation.bytesProcessed.query"
"dataFederation.bytesProcessed.daily"
"dataFederation.bytesProcessed.weekly"
"dataFederation.bytesProcessed.monthly"
Human-readable label that identifies this project limit.
|
|||||||||||||||||||||||||||||||||
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"currentUsage":
0,
-
"defaultLimit":
0,
-
"maximumLimit":
0,
-
"name":
"atlas.project.deployment.clusters",
-
"value":
0
}
Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role. This resource doesn't require the API Key to have an Access List.
|
limitName
required
|
string
Enum:
"atlas.project.security.databaseAccess.users"
"atlas.project.deployment.clusters"
"atlas.project.security.databaseAccess.customRoles"
"atlas.project.security.networkAccess.entries"
"atlas.project.security.networkAccess.crossRegionEntries"
"atlas.project.deployment.nodesPerPrivateLinkRegion"
"dataFederation.bytesProcessed.query"
"dataFederation.bytesProcessed.daily"
"dataFederation.bytesProcessed.weekly"
"dataFederation.bytesProcessed.monthly"
Human-readable label that identifies this project limit.
|
|||||||||||||||||||||||||||||||||
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
|
value
required
|
integer
<int64>
Amount to set the limit to. |
{
-
"value":
0,
-
"name":
"atlas.project.deployment.clusters"
}
{
-
"currentUsage":
0,
-
"defaultLimit":
0,
-
"maximumLimit":
0,
-
"name":
"atlas.project.deployment.clusters",
-
"value":
0
}
Returns details about the specified project's settings. To use this resource, the requesting API Key must have the Project Read Only role. This resource does not require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"isCollectDatabaseSpecificsStatisticsEnabled": true,
-
"isDataExplorerEnabled": true,
-
"isExtendedStorageSizesEnabled": true,
-
"isPerformanceAdvisorEnabled": true,
-
"isRealtimePerformancePanelEnabled": true,
-
"isSchemaAdvisorEnabled": true
}
Updates the settings of the specified project. You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting API Key must have the Project Owner role. This resource does not require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| isCollectDatabaseSpecificsStatisticsEnabled |
boolean
Flag that indicates whether to collect database-specific metrics for the specified project. |
| isDataExplorerEnabled |
boolean
Flag that indicates whether to enable the Data Explorer for the specified project. |
| isExtendedStorageSizesEnabled |
boolean
Flag that indicates whether to enable extended storage sizes for the specified project. |
| isPerformanceAdvisorEnabled |
boolean
Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project. |
| isRealtimePerformancePanelEnabled |
boolean
Flag that indicates whether to enable the Real Time Performance Panel for the specified project. |
| isSchemaAdvisorEnabled |
boolean
Flag that indicates whether to enable the Schema Advisor for the specified project. |
{
-
"isCollectDatabaseSpecificsStatisticsEnabled": true,
-
"isDataExplorerEnabled": true,
-
"isExtendedStorageSizesEnabled": true,
-
"isPerformanceAdvisorEnabled": true,
-
"isRealtimePerformancePanelEnabled": true,
-
"isSchemaAdvisorEnabled": true
}
{
-
"isCollectDatabaseSpecificsStatisticsEnabled": true,
-
"isDataExplorerEnabled": true,
-
"isExtendedStorageSizesEnabled": true,
-
"isPerformanceAdvisorEnabled": true,
-
"isRealtimePerformancePanelEnabled": true,
-
"isSchemaAdvisorEnabled": true
}
Returns details about all users in the specified project. Users belong to an organization. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| flattenTeams |
boolean
Default:
false
Flag that indicates whether the returned list should include users
who belong to a team with a role in this project. You might not
have assigned the individual users a role in this project. If
|
| includeOrgUsers |
boolean
Default:
false
Flag that indicates whether the returned list should include users
with implicit access to the project, the Organization Owner or
Organization Read Only role. You might not have assigned the
individual users a role in this project. If
|
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"country":
"string",
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"emailAddress":
"user@example.com",
-
"firstName":
"string",
-
"id":
"887821d389de9fe084df2bdf",
-
"lastAuth":
"2019-08-24T14:15:22Z",
-
"lastName":
"string",
-
"links":
[
-
],
-
"mobileNumber":
"string",
-
"password":
"stringst",
-
"roles":
[
-
{
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"orgId":
"4888442a3354817a7320eb61",
-
"roleName":
"ORG_OWNER"
}
],
-
"teamIds":
[
-
"e254e4ade2206f4520d4107d"
],
-
"username":
"user@example.com"
}
],
-
"totalCount":
0
}
Removes the specified user from the specified project. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
userId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal string that identifies MongoDB Cloud user you want to remove from the specified project. To return a application user's ID using their application username, use the Get All application users in One Project endpoint. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Creates an index on the cluster identified by its name in a rolling manner. Creating the index in this way allows index builds on one replica set member as a standalone at a time, starting with the secondary members. Creating indexes in this way requires at least one replica set election. To use this resource, the requesting API Key must have the Project Data Access Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster on which MongoDB Cloud creates an index. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Rolling index to create on the specified cluster.
|
object
(Collation)
One or more settings that specify language-specific rules to compare strings within this index. |
|
|
collection
required
|
string
Human-readable label of the collection for which MongoDB Cloud creates an index. |
|
db
required
|
string
Human-readable label of the database that holds the collection on which MongoDB Cloud creates an index. |
|
required
|
Array of objects[ items
= 1 properties
]
List that contains one or more objects that describe the parameters that you want to index. |
|
object
(IndexOptions)
One or more settings that determine how the MongoDB Cloud creates this MongoDB index. |
{
-
"collation":
{
-
"alternate":
"non-ignorable",
-
"backwards": false,
-
"caseFirst": "lower",
-
"caseLevel": false,
-
"locale":
"af",
-
"maxVariable": "punct",
-
"normalization": false,
-
"numericOrdering": false,
-
"strength":
3
},
-
"collection":
"string",
-
"db":
"string",
-
"keys":
[
-
{
-
"property1":
"string",
-
"property2":
"string"
}
],
-
"options":
{
-
"2dsphereIndexVersion": 3,
-
"background": false,
-
"bits":
26,
-
"bucketSize": 0,
-
"default_language":
"english",
-
"expireAfterSeconds": 0,
-
"hidden":
false,
-
"language_override":
"language",
-
"max":
180,
-
"min":
-180,
-
"name":
"string",
-
"partialFilterExpression": { },
-
"sparse":
false,
-
"storageEngine": { },
-
"textIndexVersion": 3,
-
"unique":
false,
-
"weights":
{ }
}
}
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns details that describe the MongoDB Cloud build and the access token that requests this resource. This starts the MongoDB Cloud API.
This resource returns information about the MongoDB application along with API key meta data.
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"apiKey":
{
-
"accessList":
[
-
{
-
"cidrBlock":
"string",
-
"ipAddress":
"string"
}
],
-
"id":
"69f24ec71f746985759551c7",
-
"publicKey":
"stringst",
-
"roles":
[
-
{
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"orgId":
"4888442a3354817a7320eb61",
-
"roleName":
"ORG_OWNER"
}
]
},
-
"appName":
"MongoDB Atlas",
-
"build":
"83be55e140f493c88e7f578aae96548dd881587b",
-
"links":
[
-
],
-
"throttling":
true
}
Returns details for all serverless instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"connectionStrings":
{
-
"privateEndpoint":
[
-
{
-
"endpoints":
[
-
{
-
"endpointId":
"string",
-
"providerName":
"AWS",
-
"region":
"string"
}
],
-
"srvConnectionString":
"string",
-
"type":
"MONGOS"
}
],
-
"standardSrv":
"string"
},
-
"createDate":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"5faec72692cee15b51eb22a4",
-
"links":
[
-
],
-
"mongoDBVersion":
"string",
-
"name":
"string",
-
"providerSettings":
{
-
"backingProviderName":
"AWS",
-
"providerName":
"SERVERLESS",
-
"regionName":
"string"
},
-
"serverlessBackupOptions":
{
-
"serverlessContinuousBackupEnabled": true
},
-
"stateName":
"IDLE",
-
"terminationProtectionEnabled": false
}
],
-
"totalCount":
0
}
Creates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Create One Serverless Instance in One Project.
|
name
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the serverless instance. |
|
required
|
object
(Cloud Service Provider Settings for a Serverless Instance)
Group of cloud provider settings that configure the provisioned MongoDB serverless instance. |
|
object
(Serverless Backup Options)
Group of settings that configure serverless backup. |
|
| terminationProtectionEnabled |
boolean
Default:
false
Flag that indicates whether termination protection is enabled on the
serverless instance. If set to |
{
-
"name":
"string",
-
"providerSettings": {
-
"backingProviderName": "AWS",
-
"providerName":
"SERVERLESS",
-
"regionName":
"string"
},
-
"serverlessBackupOptions": {
-
"serverlessContinuousBackupEnabled": true
},
-
"terminationProtectionEnabled": false
}
{
-
"connectionStrings": {
-
"privateEndpoint":
[
-
{
-
"endpoints":
[
-
{
-
"endpointId":
"string",
-
"providerName":
"AWS",
-
"region":
"string"
}
],
-
"srvConnectionString":
"string",
-
"type":
"MONGOS"
}
],
-
"standardSrv":
"string"
},
-
"createDate":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"5faec72692cee15b51eb22a4",
-
"links":
[
-
],
-
"mongoDBVersion":
"string",
-
"name":
"string",
-
"providerSettings": {
-
"backingProviderName": "AWS",
-
"providerName":
"SERVERLESS",
-
"regionName":
"string"
},
-
"serverlessBackupOptions": {
-
"serverlessContinuousBackupEnabled": true
},
-
"stateName":
"IDLE",
-
"terminationProtectionEnabled": false
}
Removes one serverless instance from the specified project. The serverless instance must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
name
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the serverless instance. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns details for one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
name
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the serverless instance. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"connectionStrings": {
-
"privateEndpoint":
[
-
{
-
"endpoints":
[
-
{
-
"endpointId":
"string",
-
"providerName":
"AWS",
-
"region":
"string"
}
],
-
"srvConnectionString":
"string",
-
"type":
"MONGOS"
}
],
-
"standardSrv":
"string"
},
-
"createDate":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"5faec72692cee15b51eb22a4",
-
"links":
[
-
],
-
"mongoDBVersion":
"string",
-
"name":
"string",
-
"providerSettings": {
-
"backingProviderName": "AWS",
-
"providerName":
"SERVERLESS",
-
"regionName":
"string"
},
-
"serverlessBackupOptions": {
-
"serverlessContinuousBackupEnabled": true
},
-
"stateName":
"IDLE",
-
"terminationProtectionEnabled": false
}
Updates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
name
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the serverless instance. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Update One Serverless Instance in One Project.
|
object
(Serverless Backup Options)
Group of settings that configure serverless backup. |
|
| terminationProtectionEnabled |
boolean
Default:
false
Flag that indicates whether termination protection is enabled on the
serverless instance. If set to |
{
-
"serverlessBackupOptions": {
-
"serverlessContinuousBackupEnabled": true
},
-
"terminationProtectionEnabled": false
}
{
-
"connectionStrings": {
-
"privateEndpoint":
[
-
{
-
"endpoints":
[
-
{
-
"endpointId":
"string",
-
"providerName":
"AWS",
-
"region":
"string"
}
],
-
"srvConnectionString":
"string",
-
"type":
"MONGOS"
}
],
-
"standardSrv":
"string"
},
-
"createDate":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"id":
"5faec72692cee15b51eb22a4",
-
"links":
[
-
],
-
"mongoDBVersion":
"string",
-
"name":
"string",
-
"providerSettings": {
-
"backingProviderName": "AWS",
-
"providerName":
"SERVERLESS",
-
"regionName":
"string"
},
-
"serverlessBackupOptions": {
-
"serverlessContinuousBackupEnabled": true
},
-
"stateName":
"IDLE",
-
"terminationProtectionEnabled": false
}
Returns, adds, edits, and removes private endpoints for serverless instances. To learn more, see the Atlas Administration API tab on the following tutorial.
Returns all private endpoints for one serverless instance. You must have at least the Project Read Only role for the project to successfully call this resource. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
instanceName
required
|
string
<= 64 characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the serverless instance associated with the tenant endpoint. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
[
-
{
-
"_id":
"76232bec98341ad1155cc244",
-
"cloudProviderEndpointId": "string",
-
"comment":
"string",
-
"endpointServiceName": "string",
-
"errorMessage": "string",
-
"status":
"RESERVATION_REQUESTED",
-
"providerName": "AWS"
}
]
Creates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. This resource doesn't require the API Key to have an Access List.
A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
instanceName
required
|
string
<= 64 characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the serverless instance for which the tenant endpoint will be created. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| comment |
string
<= 80 characters
Human-readable comment associated with the private endpoint. |
{
-
"comment":
"string"
}
{
-
"_id":
"76232bec98341ad1155cc244",
-
"cloudProviderEndpointId": "string",
-
"comment":
"string",
-
"endpointServiceName": "string",
-
"errorMessage":
"string",
-
"providerName":
"AWS",
-
"status":
"RESERVATION_REQUESTED"
}
Remove one private endpoint from one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
instanceName
required
|
string
<= 64 characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the serverless instance from which the tenant endpoint will be removed. |
|
endpointId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Return one private endpoint for one serverless instance. Identify this endpoint using its unique ID. You must have at least the Project Read Only role for the project to successfully call this resource. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
instanceName
required
|
string
<= 64 characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the serverless instance associated with the tenant endpoint. |
|
endpointId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the tenant endpoint. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"_id":
"76232bec98341ad1155cc244",
-
"cloudProviderEndpointId": "string",
-
"comment":
"string",
-
"endpointServiceName": "string",
-
"errorMessage":
"string",
-
"providerName":
"AWS",
-
"status":
"RESERVATION_REQUESTED"
}
Updates one private endpoint for one serverless instance. To use this resource, the requesting API Key must have the Project Owner role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
instanceName
required
|
string
<= 64 characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the serverless instance associated with the tenant endpoint that will be updated. |
|
endpointId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| comment |
string
<= 80 characters
Human-readable comment associated with the private endpoint. |
|
providerName
required
|
string
|
| cloudProviderEndpointId |
string^(vpce-[0-9a-f]{17}$
Unique string that identifies the private endpoint's network interface. |
{
-
"comment":
"string",
-
"providerName":
"AWS",
-
"cloudProviderEndpointId": "string"
}
{
-
"_id":
"76232bec98341ad1155cc244",
-
"cloudProviderEndpointId": "string",
-
"comment":
"string",
-
"endpointServiceName": "string",
-
"errorMessage":
"string",
-
"providerName":
"AWS",
-
"status":
"RESERVATION_REQUESTED"
}
Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"links":
[
-
],
-
"roleNames":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"teamId":
"e254e4ade2206f4520d4107d"
}
],
-
"totalCount":
0
}
Adds one team to the specified project. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project User Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Team to add to the specified project.
| roleNames |
Array of strings
unique
Items
Enum:
"GROUP_CLUSTER_MANAGER"
"GROUP_DATA_ACCESS_ADMIN"
"GROUP_DATA_ACCESS_READ_ONLY"
"GROUP_DATA_ACCESS_READ_WRITE"
"GROUP_OWNER"
"GROUP_READ_ONLY"
One or more organization- or project-level roles to assign to the MongoDB Cloud user. |
| teamId |
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal character string that identifies the team. |
{
-
"roleNames":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"teamId":
"e254e4ade2206f4520d4107d"
}
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"links":
[
-
],
-
"roleNames":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"teamId":
"e254e4ade2206f4520d4107d"
}
],
-
"totalCount":
0
}
Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Project User Admin role.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
teamId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Updates the project roles assigned to the specified team. You can grant team roles for specific projects and grant project access roles to users in the team. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project User Admin role.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
teamId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the team for which you want to update roles. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
The project roles assigned to the specified team.
| roleNames |
Array of strings
unique
Items
Enum:
"GROUP_CLUSTER_MANAGER"
"GROUP_DATA_ACCESS_ADMIN"
"GROUP_DATA_ACCESS_READ_ONLY"
"GROUP_DATA_ACCESS_READ_WRITE"
"GROUP_OWNER"
"GROUP_READ_ONLY"
One or more organization- or project-level roles to assign to the MongoDB Cloud user. |
| teamId |
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal character string that identifies the team. |
{
-
"roleNames":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"teamId":
"e254e4ade2206f4520d4107d"
}
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"links":
[
-
],
-
"roleNames":
[
-
"GROUP_CLUSTER_MANAGER"
],
-
"teamId":
"e254e4ade2206f4520d4107d"
}
],
-
"totalCount":
0
}
Returns all teams that belong to the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"id":
"e254e4ade2206f4520d4107d",
-
"links":
[
-
],
-
"name":
"string"
}
],
-
"totalCount":
0
}
Creates one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Team that you want to create in the specified organization.
|
name
required
|
string
Human-readable label that identifies the team. |
| usernames |
Array of strings
<email>
unique
List that contains the MongoDB Cloud users in this team. |
{
-
"name":
"string",
-
"usernames":
[
-
"user@example.com"
]
}
{
-
"id":
"e254e4ade2206f4520d4107d",
-
"links":
[
-
],
-
"name":
"string",
-
"usernames":
[
-
"user@example.com"
]
}
Returns one team that you identified using its human-readable name. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
|
teamName
required
|
string
Name of the team whose information you want to return. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"id":
"e254e4ade2206f4520d4107d",
-
"links":
[
-
],
-
"name":
"string"
}
Removes one team specified using its unique 24-hexadecimal digit identifier from the organization specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
|
teamId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the team that you want to delete. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns one team that you identified using its unique 24-hexadecimal digit ID. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
|
teamId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the team whose information you want to return. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"id":
"e254e4ade2206f4520d4107d",
-
"links":
[
-
],
-
"name":
"string"
}
Renames one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
|
teamId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the team that you want to rename. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Details to update on the specified team.
|
name
required
|
string
Human-readable label that identifies the team. |
| usernames |
Array of strings
<email>
unique
List that contains the MongoDB Cloud users in this team. |
{
-
"name":
"string",
-
"usernames":
[
-
"user@example.com"
]
}
{
-
"id":
"e254e4ade2206f4520d4107d",
-
"links":
[
-
],
-
"name":
"string"
}
Returns all MongoDB Cloud users assigned to the team specified using its unique 24-hexadecimal digit identifier. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization Member role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
|
teamId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the team whose application users you want to return. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"country":
"string",
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"emailAddress":
"user@example.com",
-
"firstName":
"string",
-
"id":
"887821d389de9fe084df2bdf",
-
"lastAuth":
"2019-08-24T14:15:22Z",
-
"lastName":
"string",
-
"links":
[
-
],
-
"mobileNumber":
"string",
-
"password":
"stringst",
-
"roles":
[
-
{
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"orgId":
"4888442a3354817a7320eb61",
-
"roleName":
"ORG_OWNER"
}
],
-
"teamIds":
[
-
"e254e4ade2206f4520d4107d"
],
-
"username":
"user@example.com"
}
],
-
"totalCount":
0
}
Adds one or more MongoDB Cloud users from the specified organization to the specified team. Teams enable you to grant project access roles to MongoDB Cloud users. You can assign up to 250 MongoDB Cloud users from one organization to one team. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
|
teamId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal character string that identifies the team to which you want to add MongoDB Cloud users. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
One or more MongoDB Cloud users that you want to add to the specified team.
|
id
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user. |
[
-
{
-
"id":
"887821d389de9fe084df2bdf"
}
]
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"country":
"string",
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"emailAddress":
"user@example.com",
-
"firstName":
"string",
-
"id":
"887821d389de9fe084df2bdf",
-
"lastAuth":
"2019-08-24T14:15:22Z",
-
"lastName":
"string",
-
"links":
[
-
],
-
"mobileNumber":
"string",
-
"password":
"stringst",
-
"roles":
[
-
{
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"orgId":
"4888442a3354817a7320eb61",
-
"roleName":
"ORG_OWNER"
}
],
-
"teamIds":
[
-
"e254e4ade2206f4520d4107d"
],
-
"username":
"user@example.com"
}
],
-
"totalCount":
0
}
Removes one MongoDB Cloud user from the specified team. This team belongs to one organization. Teams enable you to grant project access roles to MongoDB Cloud users. To use this resource, the requesting API Key must have the Organization User Admin role. This resource doesn't require the API Key to have an Access List.
|
orgId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
4888442a3354817a7320eb61
Unique 24-hexadecimal digit string that identifies the organization that contains your projects. Use the /orgs endpoint to retrieve all organizations to which the authenticated user has access. |
|
teamId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the team from which you want to remove one database application user. |
|
userId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies MongoDB Cloud user that you want to remove from the specified team. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns, adds, edits, and removes third-party service integration configurations. MongoDB Cloud sends alerts to each third-party service that you configure.
IMPORTANT: Each project can only have one configuration per integrationType.
Returns the settings that permit integrations with all configured third-party services. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"type":
"PAGER_DUTY"
}
],
-
"totalCount":
0
}
Removes the settings that permit configuring one third-party service integration. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This resource doesn't require the API Key to have an Access List.
|
integrationType
required
|
string
Enum:
"PAGER_DUTY"
"MICROSOFT_TEAMS"
"SLACK"
"DATADOG"
"NEW_RELIC"
"OPS_GENIE"
"VICTOR_OPS"
"WEBHOOK"
"PROMETHEUS"
Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. |
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Returns the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
integrationType
required
|
string
Enum:
"PAGER_DUTY"
"MICROSOFT_TEAMS"
"SLACK"
"DATADOG"
"NEW_RELIC"
"OPS_GENIE"
"VICTOR_OPS"
"WEBHOOK"
"PROMETHEUS"
Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"type":
"DATADOG",
-
"apiKey":
"****************************a23c",
-
"region":
"US"
}
Adds the settings for configuring one third-party service integration. These settings apply to all databases managed in the specified MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This resource doesn't require the API Key to have an Access List.
|
integrationType
required
|
string
Enum:
"PAGER_DUTY"
"MICROSOFT_TEAMS"
"SLACK"
"DATADOG"
"NEW_RELIC"
"OPS_GENIE"
"VICTOR_OPS"
"WEBHOOK"
"PROMETHEUS"
Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. |
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Third-party integration configuration that you want to configure for your project.
| type |
string
Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type. |
|
apiKey
required
|
string
Key that allows MongoDB Cloud to access your Datadog account. NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
|
| region |
string
Enum:
"US"
"EU"
"US3"
"US5"
Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API. To learn more about Datadog's regions, see Datadog Sites. |
{
-
"type":
"DATADOG",
-
"apiKey":
"****************************a23c",
-
"region":
"US"
}
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"type":
"PAGER_DUTY"
}
],
-
"totalCount":
0
}
Updates the settings for configuring integration with one third-party service. These settings apply to all databases managed in one MongoDB Cloud project. To use this resource, the requesting API Key must have the Organization Owner or Project Owner role. This resource doesn't require the API Key to have an Access List.
|
integrationType
required
|
string
Enum:
"PAGER_DUTY"
"MICROSOFT_TEAMS"
"SLACK"
"DATADOG"
"NEW_RELIC"
"OPS_GENIE"
"VICTOR_OPS"
"WEBHOOK"
"PROMETHEUS"
Human-readable label that identifies the service which you want to integrate with MongoDB Cloud. |
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Third-party integration configuration that you want to configure for your project.
| type |
string
Human-readable label that identifies the service to which you want to integrate with MongoDB Cloud. The value must match the third-party service integration type. |
|
apiKey
required
|
string
Key that allows MongoDB Cloud to access your Datadog account. NOTE: After you create a notification which requires an API or integration key, the key appears partially redacted when you:
|
| region |
string
Enum:
"US"
"EU"
"US3"
"US5"
Two-letter code that indicates which regional URL MongoDB uses to access the Datadog API. To learn more about Datadog's regions, see Datadog Sites. |
{
-
"type":
"DATADOG",
-
"apiKey":
"****************************a23c",
-
"region":
"US"
}
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"type":
"PAGER_DUTY"
}
],
-
"totalCount":
0
}
Returns, edits, and removes user-managed X.509 configurations. Also returns and generates MongoDB Cloud-managed X.509 certificates for database users. The following resources help manage database users who authenticate using X.509 certificates. You can manage these X.509 certificates or let MongoDB Cloud do it for you. If MongoDB Cloud manages your certificates, it also manages your Certificate Authority and can generate certificates for your database users. No additional X.509 configuration is required. If you manage your certificates, you must provide a Certificate Authority and generate certificates for your database users.
Returns all unexpired X.509 certificates for the specified MongoDB user. This MongoDB user belongs to one project. Atlas manages these certificates and the MongoDB user. To use this resource, the requesting API Key must have the Project Read Only role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
username
required
|
string
Human-readable label that represents the MongoDB database user account whose certificates you want to return. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| includeCount |
boolean
Default:
true
Example:
includeCount=true
Flag that indicates whether the response returns the total number of items (totalCount) in the response. |
| itemsPerPage |
integer
[ 1 .. 500 ]
Default:
100
Example:
itemsPerPage=100
Number of items that the response returns per page. |
| pageNum |
integer
>= 1
Default:
1
Example:
pageNum=1
Number of the page that displays the current set of the total objects that the response returns. |
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"_id": 0,
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"links":
[
-
],
-
"notAfter":
"2019-08-24T14:15:22Z",
-
"subject":
"CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com"
}
],
-
"totalCount":
0
}
Generates one X.509 certificate for the specified MongoDB user. Atlas manages the certificate and MongoDB user that belong to one project. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
To get MongoDB Cloud to generate a managed certificate for a database user,
set "x509Type" : "MANAGED" on the desired
MongoDB Database User.
If you are managing your own Certificate Authority (CA) in Self-Managed X.509 mode, you must generate certificates for database users using your own CA.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
username
required
|
string
Human-readable label that represents the MongoDB database user account for whom to create a certificate. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Generates one X.509 certificate for the specified MongoDB user.
| monthsUntilExpiration |
integer
<int32>
<= 24
Default:
3
Number of months that the certificate remains valid until it expires. |
{
-
"monthsUntilExpiration": 3
}
{
-
"_id":
0,
-
"createdAt":
"2019-08-24T14:15:22Z",
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"links":
[
-
],
-
"notAfter":
"2019-08-24T14:15:22Z",
-
"subject":
"CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com"
}
Clear customer-managed X.509 settings on a project, including the uploaded Certificate Authority, disabling Self-Managed X.509.
Updating this configuration triggers a rolling restart of the database.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"customerX509":
{
-
"cas":
"string",
-
"links":
[
-
]
},
-
"ldap":
{
-
"authenticationEnabled": true,
-
"authorizationEnabled": true,
-
"authzQueryTemplate":
"{USER}?memberOf?base",
-
"bindUsername":
"CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
-
"caCertificate": "string",
-
"hostname":
"string",
-
"links":
[
-
],
-
"port":
636,
-
"userToDNMapping":
[
-
{
-
"ldapQuery":
"string",
-
"match":
"(.*)",
-
"substitution":
"CN={0},CN=Users,DC=my-atlas-ldap-server,DC=example,DC=com"
}
]
},
-
"links":
[
-
]
}
Revoke MongoDB Cloud access to the specified AWS S3 bucket. This prevents this bucket to receive Atlas Cloud Backup snapshots. To use this resource, the requesting API Key must have the Project Atlas Admin role. This resource doesn't require the API Key to have an Access List.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
exportBucketId
required
|
string
[ 3 .. 63 ] characters
^((?!xn--)(?!.*-s3alias)[a-z0-9][a-z0-9-]{1,6...
Unique string that identifies the AWS S3 bucket to which you export your snapshots. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
{
-
"detail":
"(This is just an example, the exception may not be
related to this endpoint) No provider AWS
exists.",
-
"error":
400,
-
"errorCode":
"INVALID_PROVIDER",
-
"parameters":
[
-
"AWS"
],
-
"reason":
"Bad Request"
}
Restores one legacy backup for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Atlas Admin role and an entry for the project access list.
|
groupId
required
|
string
= 24 characters
^([a-f0-9]{24})$
Example:
32b6e34b3d91647abb20e7b8
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
|
clusterName
required
|
string
[ 1 .. 64 ] characters
^([a-zA-Z0-9]([a-zA-Z0-9-]){0,21}(?<!-)([\w]{...
Human-readable label that identifies the cluster with the snapshot you want to return. |
| envelope |
boolean
Default:
false
Example:
envelope=false
Flag that indicates whether Application wraps the response in an
|
| pretty |
boolean
Default:
false
Example:
pretty=false
Flag that indicates whether the response body should be in the prettyprint format. |
Legacy backup to restore to one cluster in the specified project.
| checkpointId |
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the sharded
cluster checkpoint. The checkpoint represents the point in time back
to which you want to restore you data. This parameter applies when
|
|
required
|
object
(Restore Snapshot Delivery Metadata)
Method and details that indicate how to deliver the restored snapshot data. |
| oplogInc |
integer
<int32>
>= 1
Thirty-two-bit incrementing ordinal that represents operations
within a given second. When paired with oplogTs,
this represents the point in time to which MongoDB Cloud restores
your data. This parameter applies when
|
| oplogTs |
string^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9...
Date and time from which you want to restore this snapshot. This
parameter expresses its value in ISO 8601 format in UTC. This
represents the first part of an Oplog timestamp. When paired with
oplogInc, they represent the last database
operation to which you want to restore your data. This parameter
applies when
|
| pointInTimeUTCMillis |
integer
<int64>
>= 1199145600000
Timestamp from which you want to restore this snapshot. This
parameter expresses its value in the number of milliseconds elapsed
since the
UNIX epoch.
This timestamp must fall within the last 24 hours of the current
time. This parameter applies when
|
| snapshotId |
string
= 24 characters
^([a-f0-9]{24})$
Unique 24-hexadecimal digit string that identifies the snapshot to restore. If you set snapshotId, you can't set oplogInc, oplogTs, pointInTimeUTCMillis, or checkpointId. |
{
-
"checkpointId":
"866164af7f46083e4f3a964b",
-
"delivery":
{
-
"expirationHours": 1,
-
"maxDownloads": 1,
-
"methodName":
"CLIENT_PIT_HTTP",
-
"targetClusterId":
"aff8ccf466da6f87c4b0736b",
-
"targetClusterName": "string",
-
"targetGroupId":
"ca4d8a18b96b317422974eec"
},
-
"oplogInc":
1,
-
"oplogTs":
"string",
-
"pointInTimeUTCMillis": 1199145600000,
-
"snapshotId":
"78e18e587716102f711a5bca"
}
{
-
"links":
[
-
],
-
"results":
[
-
{
-
"batchId":
"871c3da1c32654c807e5d480",
-
"clusterId":
"5faec72692cee15b51eb22a4",
-
"clusterName":
"string",
-
"created":
"2019-08-24T14:15:22Z",
-
"delivery":
{
-
"authHeader":
"string",
-
"authValue":
"string",
-
"expirationHours": 1,
-
"expires":
"2019-08-24T14:15:22Z",
-
"maxDownloads": 1,
-
"methodName":
"CLIENT_PIT_HTTP",
-
"statusName":
"NOT_STARTED",
-
"targetClusterId":
"aff8ccf466da6f87c4b0736b",
-
"targetClusterName":
"string",
-
"targetGroupId":
"ca4d8a18b96b317422974eec",
-
"url":
"string",
-
"urlV2":
"string"
},
-
"encryptionEnabled": true,
-
"groupId":
"32b6e34b3d91647abb20e7b8",
-
"hashes":
[
-
{
-
"fileName":
"string",
-
"hash":
"string",
-
"links":
[
-
],
-
"typeName":
"SHA1"
}
],
-
"id":
"e7cb93f480f357b5139ccf37",
-
"links":
[
-
],
-
"masterKeyUUID":
"72659f08-8b3c-4913-bb4e-a8a68e036502",
-
"snapshotId":
"78e18e587716102f711a5bca",
-
"statusName":
"IN_PROGRESS",
-
"timestamp":
{
-
"date":
"2019-08-24T14:15:22Z",
-
"increment":
1199145600
}
}
],
-
"totalCount":
0
}